├── .cspell.json ├── .eslintrc.json ├── .github ├── CODEOWNERS └── workflows │ ├── deploy.yml │ ├── lint.yml │ └── retext-style-guide.yml ├── .gitignore ├── .nojekyll ├── .nvmrc ├── .style ├── .spelling ├── core-glossary.txt └── skip-list.txt ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── README.md ├── assets ├── PO │ ├── storefront-de-DE.po │ ├── storefront-es-ES.po │ ├── storefront-es-MX.po │ ├── storefront-fr-FR.po │ ├── storefront-it-IT.po │ ├── storefront-nl-NL.po │ ├── storefront-pt-BR.po │ └── storefront-sv-SE.po ├── csv │ └── tracking_carrier_values.csv ├── images │ ├── B3-console.png │ ├── CouponDrawer_final.png │ ├── WCAG-guidelines-add_links.png │ ├── WCAG_guideline_skip_to_main.png │ ├── WCAG_guidelines_breadcrumbs.png │ ├── accessibility-image-widget.png │ ├── accessibility_correct_text_size.png │ ├── accessibility_good_color_contrast.png │ ├── accessibility_incorrect_text_size.png │ ├── accessibility_poor_color_contrast.png │ ├── accessibility_text_headings.png │ ├── apps-01-introduction-01.png │ ├── apps-01-introduction-02.png │ ├── apps-01-introduction-03.png │ ├── apps-02-types-01.png │ ├── apps-02-types-02.png │ ├── apps-10-buttons-01.png │ ├── apps-10-buttons-02.png │ ├── apps-id-01.png │ ├── apps-id-02.png │ ├── becoming-a-partner-01.png │ ├── becoming-a-partner-02.png │ ├── catalog-price-object-examples.png │ ├── channels-overview-01.png │ ├── channels-overview-02.png │ ├── channels-overview-03.png │ ├── channels-overview-04.png │ ├── channels-overview-05.png │ ├── channels-overview-06.png │ ├── channels-overview-07.png │ ├── channels-overview-08.png │ ├── channels-quick-start-01.png │ ├── channels-quick-start-02.png │ ├── channels-quick-start-03.png │ ├── checkout-sdk-01.png │ ├── checkout_options.png │ ├── cli-setup-instructions.png │ ├── confige_tax_settings.png │ ├── content_folder_webdav.png │ ├── contextual-filters-01.png │ ├── contextual-filters-02.png │ ├── contextual-filters-03.png │ ├── contextual-filters-04.png │ ├── coupon_drawer_example.png │ ├── create-api-account.png │ ├── create-stencil-cli-token.png │ ├── currency_beta │ │ ├── gift_certificates_multi_currency.png │ │ └── multi_currency_cart_level_discount_one.png │ ├── custom-checkout-0.png │ ├── custom-checkout-01.png │ ├── customizing_invoice_print_order_invoice.png │ ├── details-on-how-to-debug.png │ ├── devtools-tutorial-00.png │ ├── devtools-tutorial-01.png │ ├── devtools-tutorial-02.png │ ├── devtools-tutorial-03.png │ ├── devtools-tutorial-04.png │ ├── devtools-tutorial-05.png │ ├── devtools-tutorial-06.png │ ├── devtools.png │ ├── email-templates-add-button.png │ ├── email-templates-add-template.png │ ├── email-templates-change-logo-size.png │ ├── extending-screenshots-01.png │ ├── extending-screenshots-02.png │ ├── extending-screenshots-03.png │ ├── extending-screenshots-04.png │ ├── extending-screenshots-05.png │ ├── external_link_icon.svg │ ├── get_all_products_postman.png │ ├── gloabal-regions-tutorial-01.png │ ├── global-regions-tutorial-01.png │ ├── global-regions-tutorial-02.png │ ├── graphql-overview-01.png │ ├── graphql-playground-changelog.png │ ├── graphql-playground-docs.png │ ├── graphql-storefront-api-playground.png │ ├── graphql-storefront-api-playground2.png │ ├── graphql │ │ ├── favicon.png │ │ └── logo.png │ ├── multi-channel-capabilities-0.png │ ├── multi-channel-capabilities-1.png │ ├── multi-channel-capabilities-2.png │ ├── multi-currency-add-currency.png │ ├── multi-currency-admin-orders.png │ ├── multi-currency-currencies-list.png │ ├── multi-currency-currency-display.png │ ├── multi-currency-display-currency.png │ ├── multi-currency-gift-cerfiticates.png │ ├── multi-currency-invoice.png │ ├── multi-currency-order-summary.png │ ├── multi-currency-order-summary2.png │ ├── multi-currency-orders.png │ ├── multi-currency-price-overrides.png │ ├── multi-currency-transactional-currency.png │ ├── multi-currency-try-it-now.png │ ├── multi_currency_cart_level_discount_one.png │ ├── new_customer.png │ ├── nextjs-commerce-01.png │ ├── nextjs-commerce-02.png │ ├── nextjs-commerce-03.png │ ├── nextjs-commerce-04.png │ ├── nextjs-commerce-05.png │ ├── nextjs-commerce-06.png │ ├── nextjs-commerce-07.png │ ├── nextjs-commerce-08.png │ ├── nextjs-commerce-09.png │ ├── nextjs-commerce-10.png │ ├── nextjs-commerce-11.png │ ├── nextjs-commerce-12.png │ ├── nextjs-commerce-13.png │ ├── nextjs-commerce-14.png │ ├── nextjs-commerce-15.png │ ├── order-confirmation-page.png │ ├── performance-example-1.png │ ├── performance-example-2.png │ ├── performance-example-3.png │ ├── product-widget-01.png │ ├── product-widget-02.png │ ├── promotions_beta │ │ ├── merchant_view_control_panel.png │ │ ├── order_level_discount.png │ │ ├── product_level_discount.png │ │ ├── promotions_set_free_item_false.png │ │ └── promotions_set_free_item_true.png │ ├── request-runner.svg │ ├── sale_price_catalog.png │ ├── sale_price_defined_catalog.png │ ├── shipping-provider-multi-carrier-ui.png │ ├── shipping-provider-single-carrier-ui.png │ ├── stored-credit-card-management01.png │ ├── stored-credit-card-management02.png │ ├── stored-credit-card-management03.png │ ├── widget-versioning-01.png │ ├── widget-versioning-02.png │ ├── widget-versioning-03.png │ ├── widgets-code-samples-01.png │ ├── widgets-code-samples-02.png │ ├── widgets-code-samples-03.png │ ├── widgets-code-samples-04.png │ ├── widgets-code-samples-05.png │ ├── widgets-custom-template-01.png │ ├── widgets-overview-01.png │ ├── widgets-overview-02.png │ ├── widgets-overview-03.png │ └── widgets-tutorial-01.gif └── json │ ├── checkout-en.json │ ├── da.json │ ├── de.json │ ├── en.json │ ├── es-419.json │ ├── es-AR.json │ ├── es-CL.json │ ├── es-CO.json │ ├── es-MX.json │ ├── es-PE.json │ ├── es.json │ ├── fr.json │ ├── it.json │ ├── nl.json │ ├── no.json │ ├── pt-BR.json │ ├── pt.json │ └── sv.json ├── docs ├── api-docs │ ├── analytics │ │ ├── bodl-for-storefronts.mdx │ │ └── data-layer-api.mdx │ ├── apps │ │ ├── apps-id.mdx │ │ ├── apps-quick-start.mdx │ │ ├── guide │ │ │ ├── apps-01-introduction.mdx │ │ │ ├── apps-02-types.mdx │ │ │ ├── apps-03-developing.mdx │ │ │ ├── apps-04-devloper-portal.mdx │ │ │ ├── apps-05-oauth.mdx │ │ │ ├── apps-06-callbacks.mdx │ │ │ ├── apps-07-users.mdx │ │ │ ├── apps-08-events.mdx │ │ │ ├── apps-09-ui.mdx │ │ │ ├── apps-10-buttons.mdx │ │ │ ├── apps-11-best-practices.mdx │ │ │ ├── apps-12-requirements.mdx │ │ │ └── apps-13-publishing.mdx │ │ └── tutorials │ │ │ └── sample-app-next │ │ │ ├── heroku-deploy.mdx │ │ │ ├── introduction.mdx │ │ │ ├── step-1-setup.mdx │ │ │ ├── step-2-connect-to-bc.mdx │ │ │ ├── step-3-integrate-api.mdx │ │ │ └── step-4-enhance-ux.mdx │ ├── building-checkouts │ │ ├── checkout-consignment.mdx │ │ └── checkout-customizability.mdx │ ├── building-storefronts │ │ ├── abandoned-carts.mdx │ │ └── nextjs-bigcommerce.mdx │ ├── capture │ │ └── capture.mdx │ ├── cart-and-checkout │ │ ├── add-to-cart-url.mdx │ │ ├── cart-and-checkout-overview.mdx │ │ ├── channels-sites-routes.mdx │ │ ├── checkout-sdk.mdx │ │ ├── embedded-checkout-overview.mdx │ │ ├── embedded-checkout-tutorial.mdx │ │ └── working-sf-apis.mdx │ ├── catalog │ │ ├── currencies │ │ │ ├── currencies-overview.mdx │ │ │ └── how-currencies-work.mdx │ │ ├── price-list-overview.mdx │ │ ├── pricing-order-operation.mdx │ │ ├── products-overview.mdx │ │ ├── v2-v3-examples.mdx │ │ └── v2-vs-v3.mdx │ ├── channels │ │ ├── building-channel-apps.mdx │ │ ├── channel-app-best-practices.mdx │ │ ├── channel-app-requirements.mdx │ │ ├── channel-webhooks.mdx │ │ ├── channels-extending-existing.mdx │ │ ├── channels-overview.mdx │ │ ├── channels-quick-start.mdx │ │ ├── channels-storefront-tutorial.mdx │ │ └── channels-toolkit-reference.mdx │ ├── customers │ │ ├── channel-specific-customers.mdx │ │ ├── current-customer-api.mdx │ │ ├── customer-login-api.mdx │ │ ├── customers-subscribers-overview.mdx │ │ └── passwordless-login.mdx │ ├── getting-started │ │ ├── about-our-api.mdx │ │ ├── api-status-codes.mdx │ │ ├── authentication.mdx │ │ ├── best-practices.mdx │ │ ├── deprecations-and-sunsets.mdx │ │ ├── filtering.mdx │ │ ├── integration-design.mdx │ │ ├── making-requests.mdx │ │ └── rest-api-authentication.mdx │ ├── headless │ │ ├── carts.mdx │ │ ├── channels.mdx │ │ ├── checkout.mdx │ │ ├── customers.mdx │ │ ├── end-to-end-guide │ │ │ └── rest.mdx │ │ ├── orders.mdx │ │ ├── overview.mdx │ │ ├── pci-compliance.mdx │ │ └── products.mdx │ ├── management-apis │ │ ├── contextual-filters.mdx │ │ └── email-templates │ │ │ ├── email-template-examples.mdx │ │ │ └── overview.mdx │ ├── orders │ │ ├── order-refunds.mdx │ │ └── orders-api-overview.mdx │ ├── partner │ │ ├── becoming-a-partner.mdx │ │ ├── create-a-sandbox.mdx │ │ ├── dev-portal-overview.mdx │ │ ├── marketing-api-overview.mdx │ │ ├── pos │ │ │ ├── channels-pos-tutorial.mdx │ │ │ └── foundation-guide.mdx │ │ ├── resources.mdx │ │ ├── staying-current.mdx │ │ ├── subscriptions │ │ │ └── foundation-guide.mdx │ │ └── support.mdx │ ├── payments │ │ └── payments-api-overview.mdx │ ├── provider-apis │ │ └── tax │ │ │ └── overview.mdx │ ├── staging │ │ └── staging-pro-overview.mdx │ ├── store-logs │ │ └── store-logs.mdx │ ├── store-management │ │ └── shipping │ │ │ ├── shipper-hq.mdx │ │ │ ├── shipping-overview.mdx │ │ │ └── shipping-provider-api.mdx │ ├── storefront │ │ ├── graphql │ │ │ ├── graphql-api-examples.mdx │ │ │ ├── graphql-api-overview.mdx │ │ │ ├── graphql-carts-and-checkout.mdx │ │ │ ├── graphql-faceted-textual-search.mdx │ │ │ ├── graphql-products.mdx │ │ │ ├── graphql-site-content.mdx │ │ │ ├── graphql-variants.mdx │ │ │ └── rendering-widgets.mdx │ │ ├── scripts-overview.mdx │ │ └── widgets │ │ │ ├── global-regions-tutorial.mdx │ │ │ ├── product-widget-tutorial.mdx │ │ │ ├── schema.json │ │ │ ├── widget-builder.mdx │ │ │ ├── widget-versioning-tutorial.mdx │ │ │ ├── widgets-code-samples.mdx │ │ │ ├── widgets-localizing-settings.mdx │ │ │ ├── widgets-overview.mdx │ │ │ └── widgets-tutorial.mdx │ ├── tax │ │ ├── tax-properties.mdx │ │ ├── tax-rates-zones.mdx │ │ └── tax-settings.mdx │ ├── users │ │ ├── Account-level-API-accounts.mdx │ │ └── overview.mdx │ ├── void │ │ └── void.mdx │ └── webhooks │ │ ├── about-webhooks.mdx │ │ ├── setting-up-webhooks.mdx │ │ └── webhook-events.mdx ├── bigcommerce-for-wordpress │ ├── changelog │ │ └── plugin-changelog.mdx │ ├── extending-the-plugin │ │ ├── amp-for-the-plugin.mdx │ │ ├── bigcommerce-for-wordpress-cron.mdx │ │ ├── code-reference.mdx │ │ ├── customization-guide.html │ │ ├── customization-guide.mdx │ │ ├── multi-channel-capabilities.mdx │ │ └── proxy-rest-api-endpoints.mdx │ ├── getting-started │ │ ├── app-compatibility.mdx │ │ ├── gutenberg-support.mdx │ │ ├── install.mdx │ │ ├── introduction.mdx │ │ ├── site-launch-checklist.mdx │ │ └── supported-features.mdx │ └── setup │ │ ├── multi-site.mdx │ │ ├── plugin-settings.mdx │ │ ├── product-import.mdx │ │ ├── shortcodes.mdx │ │ └── troubleshooting.mdx ├── legacy │ ├── blueprint-reference │ │ ├── blueprint-layouts.mdx │ │ ├── blueprint-panels.mdx │ │ └── blueprint-snippets.mdx │ ├── blueprint-themes │ │ ├── anatomy-of-a-theme.mdx │ │ ├── blueprint-and-developer-mode.mdx │ │ ├── blueprint-email-templates.mdx │ │ ├── blueprint-template-syntax.mdx │ │ ├── blueprint-theme-update-process.mdx │ │ ├── checkout-styling.mdx │ │ ├── global-variables.mdx │ │ ├── lng-variables.mdx │ │ ├── product-filtering-toolkit.mdx │ │ ├── recaptcha-two.mdx │ │ ├── store-wide-global-panels.mdx │ │ ├── store-wide-global-variables.mdx │ │ └── style-editor.mdx │ ├── stencil-themes │ │ ├── installing-legacy-theme-modules.mdx │ │ └── stored-credit-card-management.mdx │ ├── storefronts │ │ └── nextjs-commerce-guide.mdx │ ├── v2-catalog-products │ │ ├── v2-brands.mdx │ │ ├── v2-bulk-pricing.mdx │ │ ├── v2-categories.mdx │ │ ├── v2-custom-fields.mdx │ │ ├── v2-option-set-options.mdx │ │ ├── v2-option-sets.mdx │ │ ├── v2-option-values.mdx │ │ ├── v2-options.mdx │ │ ├── v2-product-images.mdx │ │ ├── v2-product-options.mdx │ │ ├── v2-product-reviews.mdx │ │ ├── v2-product-rules.mdx │ │ ├── v2-product-sku.mdx │ │ ├── v2-product-videos.mdx │ │ └── v2-products.mdx │ └── v2-products │ │ └── v2-v3.mdx ├── msf │ ├── managing-store-configuration.mdx │ ├── msf-api-guide.mdx │ ├── msf-app-compatibility.mdx │ └── msf-overview.mdx ├── partner-apps │ └── bundleb2b │ │ └── b2b-edition.mdx ├── start │ └── introduction-to-bigcommerce.mdx └── stencil-docs │ ├── configure-store-design-ui │ ├── defining-global-styles.mdx │ ├── defining-ui-options.mdx │ └── store-design-overview.mdx │ ├── customizing-checkout │ ├── checkout-confirmation-injection.mdx │ ├── checkout-sdk-example.mdx │ ├── checkout-sdk-quickstart.mdx │ ├── custom-order-confirmation.mdx │ ├── open-checkout-quick-start.mdx │ ├── open-source-checkout.mdx │ ├── optimized-one-page-checkout.mdx │ └── paypal-smart-buttons.mdx │ ├── deploying-a-theme │ ├── bundling-and-pushing.mdx │ ├── checking-a-themes-size.mdx │ ├── naming-your-theme.mdx │ ├── preparing-thumbnail-images.mdx │ ├── theme-best-practices.mdx │ └── troubleshooting-theme-uploads.mdx │ ├── developing-further │ ├── add-recaptcha-v2.mdx │ ├── catalog-price-object.mdx │ ├── customizing-emails.mdx │ ├── customizing-invoices.mdx │ ├── customizing-printable-packing-slips.mdx │ ├── google-analytics-enhanced-ecommerce.mdx │ ├── modifying-forms.mdx │ ├── stored-credit-card-management.mdx │ └── theme-updates-and-version-control.mdx │ ├── getting-started │ ├── about-stencil.mdx │ ├── stencil-technology-stack.mdx │ └── transitioning-to-stencil.mdx │ ├── installing-stencil-cli │ ├── incompatible-directives.mdx │ ├── installing-stencil.mdx │ ├── live-previewing-a-theme.mdx │ ├── node-sass.mdx │ ├── stencil-cli-options-and-commands.mdx │ └── troubleshooting-your-setup.mdx │ ├── javascript-and-event-hooks │ ├── adding-javascript.mdx │ ├── customizing-javascript.mdx │ ├── dynamic-content-rendering.mdx │ ├── event-hooks.mdx │ ├── npm-tutorials.mdx │ ├── remote-api-tutorial.mdx │ └── rendering-html-with-ajax.mdx │ ├── localization │ ├── localization-tutorial.mdx │ ├── localizing-stores.mdx │ ├── multi-language-checkout.mdx │ ├── translating-regions.mdx │ └── translation-keys.mdx │ ├── page-builder │ ├── configuration.mdx │ ├── page-builder-overview.mdx │ ├── third-party-widgets.mdx │ ├── wallet-buttons.mdx │ ├── widget-ui-schema.mdx │ ├── widget_alignment.yaml │ ├── widget_boolean.yaml │ ├── widget_box_model.yaml │ ├── widget_code.yaml │ ├── widget_color.yaml │ ├── widget_element_settings.yaml │ ├── widget_image_manager.yaml │ ├── widget_input.yaml │ ├── widget_number.yaml │ ├── widget_product_ID.yaml │ ├── widget_product_image.yaml │ ├── widget_range.yaml │ ├── widget_regex_input.yaml │ ├── widget_select.yaml │ ├── widget_text.yaml │ ├── widget_typography.yaml │ └── widget_visibility.yaml │ ├── reference-docs │ ├── common-objects.mdx │ ├── front-matter-reference.mdx │ ├── global-objects-and-properties.mdx │ ├── handlebars-helpers-reference.mdx │ ├── other-objects-and-properties-overview.mdx │ ├── stencil-utils-api-reference.mdx │ ├── styles-and-properties.mdx │ └── theme-objects.mdx │ └── storefront-customization │ ├── WCAG-compliance-levels.mdx │ ├── custom-sass-functions.mdx │ ├── custom-templates.mdx │ ├── directory-structure.mdx │ ├── early-hints.mdx │ ├── implementing-WCAG-guidelines.mdx │ ├── localizing-variation-descriptions.mdx │ ├── page-composition-and-styling.mdx │ ├── theme-accessibility.mdx │ ├── theme-assets.mdx │ ├── using-custom-fonts-and-icons.mdx │ ├── using-disqus.mdx │ └── using-front-matter.mdx ├── package-lock.json ├── package.json └── pull_request_template.md /.cspell.json: -------------------------------------------------------------------------------- 1 | { 2 | // Enable your dictionary by adding it to the list of `dictionaries` 3 | "dictionaries": [ 4 | "core-glossary" 5 | ], 6 | "ignoreWords": [ 7 | "skip-list" 8 | ], 9 | // Tell CSpell about your dictionary 10 | "dictionaryDefinitions": [ 11 | { 12 | "name": "core-glossary", 13 | // Path to the custom word file. Relative to this `cspell.json` file. 14 | "path": "./.style/core-glossary.txt", 15 | // Some editor extensions will use `addWords` for adding words to your 16 | // personal dictionary. 17 | "addWords": true 18 | }, 19 | { 20 | "name": "skip-list", //these aren't glossary words, but shouldn't be spell checked away 21 | "path": "./.style/skip-list.txt", 22 | "addWords": true 23 | } 24 | ] 25 | } 26 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": ["plugin:mdx/recommended"], 3 | // optional, if you want to lint code blocks at the same time 4 | "settings": { 5 | "mdx/code-blocks": true, 6 | // optional, if you want to disable language mapper, set it to `false` 7 | // if you want to override the default language mapper inside, you can provide your own 8 | "mdx/language-mapper": {} 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # These owners will be the default owners for everything in the repo. Unless a later match takes precedence, @global-owner1 and @global-owner2 will be requested for review when someone opens a pull request. 2 | 3 | @slsriehl @bigcommerce/dev-docs-team @markcmurphy 4 | 5 | # Teams can be specified as code owners as well. Teams should 6 | # be identified in the format @org/team-name. Teams must have 7 | # explicit write access to the repository. In this example, 8 | # the octocats team in the octo-org organization owns all .md files. 9 | -------------------------------------------------------------------------------- /.github/workflows/deploy.yml: -------------------------------------------------------------------------------- 1 | name: Deploy 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | workflow_dispatch: 8 | inputs: 9 | buildWithCache: 10 | description: 'Build with cache' 11 | default: true 12 | required: false 13 | type: boolean 14 | 15 | jobs: 16 | build: 17 | runs-on: ubuntu-latest 18 | 19 | steps: 20 | - name: Checkout code 21 | uses: actions/checkout@v2 22 | 23 | - name: Trigger Vercel Deploy Hook 24 | run: | 25 | curl -X POST ${{ secrets.VERCEL_DEPLOY_HOOK_URL }}?buildCache=${{ inputs.buildWithCache }} 26 | -------------------------------------------------------------------------------- /.github/workflows/lint.yml: -------------------------------------------------------------------------------- 1 | name: lint-valid-mdx 2 | on: 3 | - pull_request 4 | 5 | jobs: 6 | lint: 7 | runs-on: ubuntu-latest 8 | 9 | steps: 10 | - uses: actions/checkout@v3 11 | - name: Use Node.js v18.x 12 | uses: actions/setup-node@v3 13 | with: 14 | node-version: 18.x 15 | - run: npm ci 16 | - run: npm run lint 17 | -------------------------------------------------------------------------------- /.github/workflows/retext-style-guide.yml: -------------------------------------------------------------------------------- 1 | name: remark 2 | on: [pull_request] 3 | jobs: 4 | remark: 5 | name: runner / retext-style-guide 6 | runs-on: ubuntu-latest 7 | steps: 8 | - uses: actions/checkout@v3 9 | - name: quality-docs-github-check 10 | uses: bigcommerce/dev-docs-style-guide-action@master 11 | with: 12 | github_token: ${{ secrets.GITHUB_TOKEN }} 13 | reporter: github-pr-review 14 | level: warning 15 | filter_mode: added 16 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | .scratch 3 | .notes 4 | node_modules 5 | .DS_Store 6 | .vscode 7 | -------------------------------------------------------------------------------- /.nojekyll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/.nojekyll -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | 18 2 | -------------------------------------------------------------------------------- /.style/core-glossary.txt: -------------------------------------------------------------------------------- 1 | 2 | BigCommerce 3 | bigcommerce 4 | bodl 5 | BODL 6 | upsert 7 | !above 8 | !access 9 | !allows 10 | !dev key 11 | !developer key 12 | +application 13 | !back-end 14 | !front-end 15 | !backwards compatible 16 | !below 17 | !blacklist 18 | !whitelist 19 | allowlist 20 | denylist 21 | !check 22 | !click on 23 | ![here] 24 | ![click here] 25 | !id 26 | ID 27 | !comprise 28 | !cons 29 | !console 30 | !content type 31 | media type 32 | !curated roles 33 | !cleansing 34 | !data set 35 | !datasource 36 | !data store 37 | !datatype 38 | !deep-link* 39 | !deselect 40 | !desire 41 | !dialogue 42 | !doc 43 | !docs 44 | !article 45 | !topic 46 | !dropdown 47 | !dummy 48 | !easy 49 | !easily 50 | !e.g. 51 | !eg 52 | !tag 53 | !e-mail 54 | !end point 55 | !file name 56 | !filesystem 57 | !flag 58 | !functionality 59 | !he 60 | !him 61 | !his 62 | !she 63 | !her 64 | !hers 65 | !hamburger 66 | !hit 67 | !hover 68 | !host name 69 | !i.e. 70 | !ie 71 | !impactful 72 | !ingest 73 | !in order to 74 | !just 75 | 76 | via 77 | will 78 | -------------------------------------------------------------------------------- /.style/skip-list.txt: -------------------------------------------------------------------------------- 1 | usleep 2 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. 6 | 7 | ## Our Standards 8 | 9 | Examples of behavior that contributes to creating a positive environment include: 10 | 11 | * Using welcoming and inclusive language 12 | * Being respectful of differing viewpoints and experiences 13 | * Gracefully accepting constructive criticism 14 | * Focusing on what is best for the community 15 | * Showing empathy towards other community members 16 | 17 | Examples of unacceptable behavior by participants include: 18 | 19 | * The use of sexualized language or imagery and unwelcome sexual attention or advances 20 | * Trolling, insulting/derogatory comments, and personal or political attacks 21 | * Public or private harassment 22 | * Publishing others' private information, such as a physical or electronic address, without explicit permission 23 | * Other conduct which could reasonably be considered inappropriate in a professional setting 24 | 25 | ## Our Responsibilities 26 | 27 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. 28 | 29 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. 30 | 31 | ## Scope 32 | 33 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. 34 | 35 | ## Enforcement 36 | 37 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at . The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. 38 | 39 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. 40 | 41 | ## Attribution 42 | 43 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] 44 | 45 | [homepage]: http://contributor-covenant.org 46 | [version]: http://contributor-covenant.org/version/1/4/ 47 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to BigCommerce Developer Documentation 2 | 3 | - [Making a Quick Edit](#making-a-quick-edit) 4 | - [Editing Locally](#editing-locally) 5 | - [Commit Messages](#commit-messages) 6 | - [Style Guides](#style-guides) 7 | - [Contributing to Other Projects](#contributing-to-other-projects) 8 | 9 | Thanks for showing interest in contributing! 10 | 11 | The following is a set of guidelines for contributing to BigCommerce's Developer Documentation. These are guidelines, not rules. Use your best judgment, and make proposed changes to this document in a pull request. 12 | 13 | ## Making a Quick Edit 14 | 15 | The easiest way to edit a file is using GitHub's web interface: 16 | 17 | 1. Navigate to the file in GitHub. For example, [making-requests.md](https://github.com/bigcommerce/dev-docs/blob/main/docs/api-docs/getting-started/making-requests.mdx). 18 | 19 | 2. Click the **pencil** icon to **Edit This File**. 20 | 3. Make the edit. 21 | 4. Type a commit message. 22 | 5. Select **Create a new branch for this commit and start a pull request**. 23 | 6. Give the branch a descriptive name. 24 | 7. Click **Propose file change**. 25 | 8. Give the pull request a descriptive title. 26 | 9. Fill in the pull request description. 27 | 10. Click **Create pull request**. 28 | 29 | That's it! You're done. 30 | 31 | ## Editing Locally 32 | 33 | For more complex changes, fork and edit locally: 34 | 35 | 1. Fork `bigcommerce/dev-docs`. 36 | 37 | 2. `git clone` the fork to your local machine. 38 | 39 | 3. Make edits on a new branch in your IDE of choice. 40 | 41 | 4. Commit and push changes to your remote repo. 42 | 43 | 5. Create a [pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to `bigcommerce:dev-docs/main`. 44 | 45 | 46 | ## Commit Messages 47 | 48 | - Always include subject; include body when necessary. 49 | - Use present tense ("Add feature" not "Added feature"). 50 | - Use imperative mood ("Fix broken link..." not "Fixes broken link..."). 51 | - Separate subject from body with a blank line. 52 | - Limit the subject line to 50 characters. 53 | - Capitalize the subject line. 54 | - Do not end the subject line with a period. 55 | - Use the body to explain what and why versus how. 56 | 57 | ## Style Guides 58 | 59 | - [Documentation Style Guide](_project/_doc_style_guide.md) 60 | - [API Specification Style Guide](_project/_spec_style_guide.md) 61 | 62 | ## Contributing to Other Projects 63 | 64 | There are many other public BigCommerce repositories accepting contributions. If you're interested in contributing to those projects, see the [full list of public source repos](https://github.com/bigcommerce?utf8=%E2%9C%93&q=is%3Apublic&type=source&language=). Also, consider joining the [BigCommerce Developer Community](https://developer.bigcommerce.com/community). 65 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # BigCommerce Developer Documentation 2 | 3 | **As of December 27, 2023, you can find all the public BigCommerce DevDocs at [https://github.com/bigcommerce/docs](https://github.com/bigcommerce/docs)!** 4 | 5 | This repository is archived and read only. The final commit has been tagged. 6 | 7 | This consolidation lets the BigCommerce DX team offer a more streamlined developer experience. We look forward to seeing your [issues](https://github.com/bigcommerce/docs/issues), [discussions](https://github.com/bigcommerce/docs/discussions), and [pull requests](https://github.com/bigcommerce/docs/pulls) at [bigcommerce/docs](https://github.com/bigcommerce/docs)! 8 | -------------------------------------------------------------------------------- /assets/images/B3-console.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/B3-console.png -------------------------------------------------------------------------------- /assets/images/CouponDrawer_final.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/CouponDrawer_final.png -------------------------------------------------------------------------------- /assets/images/WCAG-guidelines-add_links.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/WCAG-guidelines-add_links.png -------------------------------------------------------------------------------- /assets/images/WCAG_guideline_skip_to_main.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/WCAG_guideline_skip_to_main.png -------------------------------------------------------------------------------- /assets/images/WCAG_guidelines_breadcrumbs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/WCAG_guidelines_breadcrumbs.png -------------------------------------------------------------------------------- /assets/images/accessibility-image-widget.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/accessibility-image-widget.png -------------------------------------------------------------------------------- /assets/images/accessibility_correct_text_size.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/accessibility_correct_text_size.png -------------------------------------------------------------------------------- /assets/images/accessibility_good_color_contrast.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/accessibility_good_color_contrast.png -------------------------------------------------------------------------------- /assets/images/accessibility_incorrect_text_size.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/accessibility_incorrect_text_size.png -------------------------------------------------------------------------------- /assets/images/accessibility_poor_color_contrast.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/accessibility_poor_color_contrast.png -------------------------------------------------------------------------------- /assets/images/accessibility_text_headings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/accessibility_text_headings.png -------------------------------------------------------------------------------- /assets/images/apps-01-introduction-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/apps-01-introduction-01.png -------------------------------------------------------------------------------- /assets/images/apps-01-introduction-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/apps-01-introduction-02.png -------------------------------------------------------------------------------- /assets/images/apps-01-introduction-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/apps-01-introduction-03.png -------------------------------------------------------------------------------- /assets/images/apps-02-types-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/apps-02-types-01.png -------------------------------------------------------------------------------- /assets/images/apps-02-types-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/apps-02-types-02.png -------------------------------------------------------------------------------- /assets/images/apps-10-buttons-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/apps-10-buttons-01.png -------------------------------------------------------------------------------- /assets/images/apps-10-buttons-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/apps-10-buttons-02.png -------------------------------------------------------------------------------- /assets/images/apps-id-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/apps-id-01.png -------------------------------------------------------------------------------- /assets/images/apps-id-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/apps-id-02.png -------------------------------------------------------------------------------- /assets/images/becoming-a-partner-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/becoming-a-partner-01.png -------------------------------------------------------------------------------- /assets/images/becoming-a-partner-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/becoming-a-partner-02.png -------------------------------------------------------------------------------- /assets/images/catalog-price-object-examples.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/catalog-price-object-examples.png -------------------------------------------------------------------------------- /assets/images/channels-overview-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/channels-overview-01.png -------------------------------------------------------------------------------- /assets/images/channels-overview-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/channels-overview-02.png -------------------------------------------------------------------------------- /assets/images/channels-overview-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/channels-overview-03.png -------------------------------------------------------------------------------- /assets/images/channels-overview-04.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/channels-overview-04.png -------------------------------------------------------------------------------- /assets/images/channels-overview-05.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/channels-overview-05.png -------------------------------------------------------------------------------- /assets/images/channels-overview-06.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/channels-overview-06.png -------------------------------------------------------------------------------- /assets/images/channels-overview-07.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/channels-overview-07.png -------------------------------------------------------------------------------- /assets/images/channels-overview-08.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/channels-overview-08.png -------------------------------------------------------------------------------- /assets/images/channels-quick-start-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/channels-quick-start-01.png -------------------------------------------------------------------------------- /assets/images/channels-quick-start-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/channels-quick-start-02.png -------------------------------------------------------------------------------- /assets/images/channels-quick-start-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/channels-quick-start-03.png -------------------------------------------------------------------------------- /assets/images/checkout-sdk-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/checkout-sdk-01.png -------------------------------------------------------------------------------- /assets/images/checkout_options.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/checkout_options.png -------------------------------------------------------------------------------- /assets/images/cli-setup-instructions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/cli-setup-instructions.png -------------------------------------------------------------------------------- /assets/images/confige_tax_settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/confige_tax_settings.png -------------------------------------------------------------------------------- /assets/images/content_folder_webdav.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/content_folder_webdav.png -------------------------------------------------------------------------------- /assets/images/contextual-filters-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/contextual-filters-01.png -------------------------------------------------------------------------------- /assets/images/contextual-filters-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/contextual-filters-02.png -------------------------------------------------------------------------------- /assets/images/contextual-filters-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/contextual-filters-03.png -------------------------------------------------------------------------------- /assets/images/contextual-filters-04.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/contextual-filters-04.png -------------------------------------------------------------------------------- /assets/images/coupon_drawer_example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/coupon_drawer_example.png -------------------------------------------------------------------------------- /assets/images/create-api-account.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/create-api-account.png -------------------------------------------------------------------------------- /assets/images/create-stencil-cli-token.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/create-stencil-cli-token.png -------------------------------------------------------------------------------- /assets/images/currency_beta/gift_certificates_multi_currency.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/currency_beta/gift_certificates_multi_currency.png -------------------------------------------------------------------------------- /assets/images/currency_beta/multi_currency_cart_level_discount_one.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/currency_beta/multi_currency_cart_level_discount_one.png -------------------------------------------------------------------------------- /assets/images/custom-checkout-0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/custom-checkout-0.png -------------------------------------------------------------------------------- /assets/images/custom-checkout-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/custom-checkout-01.png -------------------------------------------------------------------------------- /assets/images/customizing_invoice_print_order_invoice.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/customizing_invoice_print_order_invoice.png -------------------------------------------------------------------------------- /assets/images/details-on-how-to-debug.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/details-on-how-to-debug.png -------------------------------------------------------------------------------- /assets/images/devtools-tutorial-00.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/devtools-tutorial-00.png -------------------------------------------------------------------------------- /assets/images/devtools-tutorial-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/devtools-tutorial-01.png -------------------------------------------------------------------------------- /assets/images/devtools-tutorial-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/devtools-tutorial-02.png -------------------------------------------------------------------------------- /assets/images/devtools-tutorial-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/devtools-tutorial-03.png -------------------------------------------------------------------------------- /assets/images/devtools-tutorial-04.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/devtools-tutorial-04.png -------------------------------------------------------------------------------- /assets/images/devtools-tutorial-05.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/devtools-tutorial-05.png -------------------------------------------------------------------------------- /assets/images/devtools-tutorial-06.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/devtools-tutorial-06.png -------------------------------------------------------------------------------- /assets/images/devtools.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/devtools.png -------------------------------------------------------------------------------- /assets/images/email-templates-add-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/email-templates-add-button.png -------------------------------------------------------------------------------- /assets/images/email-templates-add-template.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/email-templates-add-template.png -------------------------------------------------------------------------------- /assets/images/email-templates-change-logo-size.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/email-templates-change-logo-size.png -------------------------------------------------------------------------------- /assets/images/extending-screenshots-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/extending-screenshots-01.png -------------------------------------------------------------------------------- /assets/images/extending-screenshots-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/extending-screenshots-02.png -------------------------------------------------------------------------------- /assets/images/extending-screenshots-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/extending-screenshots-03.png -------------------------------------------------------------------------------- /assets/images/extending-screenshots-04.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/extending-screenshots-04.png -------------------------------------------------------------------------------- /assets/images/extending-screenshots-05.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/extending-screenshots-05.png -------------------------------------------------------------------------------- /assets/images/external_link_icon.svg: -------------------------------------------------------------------------------- 1 | 2 | 17 | 19 | 20 | 22 | image/svg+xml 23 | 25 | 26 | 27 | 28 | 30 | 50 | 53 | 58 | 59 | 60 | -------------------------------------------------------------------------------- /assets/images/get_all_products_postman.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/get_all_products_postman.png -------------------------------------------------------------------------------- /assets/images/gloabal-regions-tutorial-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/gloabal-regions-tutorial-01.png -------------------------------------------------------------------------------- /assets/images/global-regions-tutorial-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/global-regions-tutorial-01.png -------------------------------------------------------------------------------- /assets/images/global-regions-tutorial-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/global-regions-tutorial-02.png -------------------------------------------------------------------------------- /assets/images/graphql-overview-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/graphql-overview-01.png -------------------------------------------------------------------------------- /assets/images/graphql-playground-changelog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/graphql-playground-changelog.png -------------------------------------------------------------------------------- /assets/images/graphql-playground-docs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/graphql-playground-docs.png -------------------------------------------------------------------------------- /assets/images/graphql-storefront-api-playground.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/graphql-storefront-api-playground.png -------------------------------------------------------------------------------- /assets/images/graphql-storefront-api-playground2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/graphql-storefront-api-playground2.png -------------------------------------------------------------------------------- /assets/images/graphql/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/graphql/favicon.png -------------------------------------------------------------------------------- /assets/images/graphql/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/graphql/logo.png -------------------------------------------------------------------------------- /assets/images/multi-channel-capabilities-0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-channel-capabilities-0.png -------------------------------------------------------------------------------- /assets/images/multi-channel-capabilities-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-channel-capabilities-1.png -------------------------------------------------------------------------------- /assets/images/multi-channel-capabilities-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-channel-capabilities-2.png -------------------------------------------------------------------------------- /assets/images/multi-currency-add-currency.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-add-currency.png -------------------------------------------------------------------------------- /assets/images/multi-currency-admin-orders.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-admin-orders.png -------------------------------------------------------------------------------- /assets/images/multi-currency-currencies-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-currencies-list.png -------------------------------------------------------------------------------- /assets/images/multi-currency-currency-display.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-currency-display.png -------------------------------------------------------------------------------- /assets/images/multi-currency-display-currency.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-display-currency.png -------------------------------------------------------------------------------- /assets/images/multi-currency-gift-cerfiticates.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-gift-cerfiticates.png -------------------------------------------------------------------------------- /assets/images/multi-currency-invoice.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-invoice.png -------------------------------------------------------------------------------- /assets/images/multi-currency-order-summary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-order-summary.png -------------------------------------------------------------------------------- /assets/images/multi-currency-order-summary2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-order-summary2.png -------------------------------------------------------------------------------- /assets/images/multi-currency-orders.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-orders.png -------------------------------------------------------------------------------- /assets/images/multi-currency-price-overrides.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-price-overrides.png -------------------------------------------------------------------------------- /assets/images/multi-currency-transactional-currency.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-transactional-currency.png -------------------------------------------------------------------------------- /assets/images/multi-currency-try-it-now.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi-currency-try-it-now.png -------------------------------------------------------------------------------- /assets/images/multi_currency_cart_level_discount_one.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/multi_currency_cart_level_discount_one.png -------------------------------------------------------------------------------- /assets/images/new_customer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/new_customer.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-01.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-02.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-03.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-04.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-04.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-05.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-05.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-06.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-06.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-07.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-07.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-08.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-08.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-09.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-09.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-10.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-10.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-11.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-11.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-12.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-12.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-13.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-13.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-14.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-14.png -------------------------------------------------------------------------------- /assets/images/nextjs-commerce-15.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/nextjs-commerce-15.png -------------------------------------------------------------------------------- /assets/images/order-confirmation-page.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/order-confirmation-page.png -------------------------------------------------------------------------------- /assets/images/performance-example-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/performance-example-1.png -------------------------------------------------------------------------------- /assets/images/performance-example-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/performance-example-2.png -------------------------------------------------------------------------------- /assets/images/performance-example-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/performance-example-3.png -------------------------------------------------------------------------------- /assets/images/product-widget-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/product-widget-01.png -------------------------------------------------------------------------------- /assets/images/product-widget-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/product-widget-02.png -------------------------------------------------------------------------------- /assets/images/promotions_beta/merchant_view_control_panel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/promotions_beta/merchant_view_control_panel.png -------------------------------------------------------------------------------- /assets/images/promotions_beta/order_level_discount.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/promotions_beta/order_level_discount.png -------------------------------------------------------------------------------- /assets/images/promotions_beta/product_level_discount.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/promotions_beta/product_level_discount.png -------------------------------------------------------------------------------- /assets/images/promotions_beta/promotions_set_free_item_false.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/promotions_beta/promotions_set_free_item_false.png -------------------------------------------------------------------------------- /assets/images/promotions_beta/promotions_set_free_item_true.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/promotions_beta/promotions_set_free_item_true.png -------------------------------------------------------------------------------- /assets/images/sale_price_catalog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/sale_price_catalog.png -------------------------------------------------------------------------------- /assets/images/sale_price_defined_catalog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/sale_price_defined_catalog.png -------------------------------------------------------------------------------- /assets/images/shipping-provider-multi-carrier-ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/shipping-provider-multi-carrier-ui.png -------------------------------------------------------------------------------- /assets/images/shipping-provider-single-carrier-ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/shipping-provider-single-carrier-ui.png -------------------------------------------------------------------------------- /assets/images/stored-credit-card-management01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/stored-credit-card-management01.png -------------------------------------------------------------------------------- /assets/images/stored-credit-card-management02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/stored-credit-card-management02.png -------------------------------------------------------------------------------- /assets/images/stored-credit-card-management03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/stored-credit-card-management03.png -------------------------------------------------------------------------------- /assets/images/widget-versioning-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widget-versioning-01.png -------------------------------------------------------------------------------- /assets/images/widget-versioning-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widget-versioning-02.png -------------------------------------------------------------------------------- /assets/images/widget-versioning-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widget-versioning-03.png -------------------------------------------------------------------------------- /assets/images/widgets-code-samples-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widgets-code-samples-01.png -------------------------------------------------------------------------------- /assets/images/widgets-code-samples-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widgets-code-samples-02.png -------------------------------------------------------------------------------- /assets/images/widgets-code-samples-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widgets-code-samples-03.png -------------------------------------------------------------------------------- /assets/images/widgets-code-samples-04.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widgets-code-samples-04.png -------------------------------------------------------------------------------- /assets/images/widgets-code-samples-05.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widgets-code-samples-05.png -------------------------------------------------------------------------------- /assets/images/widgets-custom-template-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widgets-custom-template-01.png -------------------------------------------------------------------------------- /assets/images/widgets-overview-01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widgets-overview-01.png -------------------------------------------------------------------------------- /assets/images/widgets-overview-02.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widgets-overview-02.png -------------------------------------------------------------------------------- /assets/images/widgets-overview-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widgets-overview-03.png -------------------------------------------------------------------------------- /assets/images/widgets-tutorial-01.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigcommerce/dev-docs/e38de6d782fff34fad031afe1fae3886be9f05bb/assets/images/widgets-tutorial-01.gif -------------------------------------------------------------------------------- /docs/api-docs/apps/apps-id.mdx: -------------------------------------------------------------------------------- 1 | # Locating the ID of an APP 2 | 3 | 4 | 5 | Select partners [building channel apps](/docs/integrations/channels/guide) need to know their app's ID in order to create and modify the channel's configuration. This tutorial demonstrates how to find an app's ID in the [Developer Portal](#find-in-developer-portal) and the [control panel](#find-in-control-panel). 6 | 7 | 8 | 9 | ## Find in control panel 10 | An app's ID can be found in the URL while on the app's page in a store's control panel. The location of the app's page depends on if the app is installed or uninstalled. 11 | 12 | * **Uninstalled Draft Apps:** **Apps** > **My Apps** > [**My Draft Apps**](https://login.bigcommerce.com/deep-links/manage/marketplace/apps/my-apps/drafts) 13 | 14 | * **Installed Apps:** **Apps** > [**My Apps**](https://login.bigcommerce.com/deep-links/manage/marketplace/apps/my-apps) 15 | 16 | 17 | To open the app page, click the app: 18 | 19 | ![Draft App](https://storage.googleapis.com/bigcommerce-production-dev-center/images/apps/apps-id-01.png "Draft App") 20 | 21 | The app ID is in the URL after `/manage/marketplace/apps/`: 22 | 23 | ![Draft App ID](https://storage.googleapis.com/bigcommerce-production-dev-center/images/apps/apps-id-02.png "Draft App ID") 24 | 25 | ## Find in Developer Portal 26 | 27 | 28 | To find an app's ID in the [Developer Portal](https://devtools.bigcommerce.com/my/apps): 29 | 1. Sign in to the [Developer Portal](https://devtools.bigcommerce.com/my/apps). 30 | 31 | 2. Click **Edit App**. 32 | 33 | 3. Identify the app's ID is in the URL (ex: `/my/apps/{APP_ID}/summary?review=false`). 34 | 35 | 36 | ## Usage 37 | 38 | Once you obtain the app ID, you can use it to create or modify the app configuration for a channel using the [Create a channel](/docs/rest-management/channels#create-a-channel) or [Update a channel](/docs/rest-management/channels#update-a-channel) endpoint. 39 | 40 | ```http filename="Example request: Create a channel with app configuration" showLineNumbers copy 41 | POST https://api.bigcommerce.com/stores/{STORE_HASH}/v3/channels 42 | X-Auth-Token: {ACCESS_TOKEN} 43 | Content-Type: application/json 44 | Accept: application/json 45 | 46 | [{ 47 | "type": "type of channel", 48 | "platform": "sales channel platform", 49 | "name": "name of the sales channel", 50 | "external_id": "", 51 | "status": "connected", 52 | "app": { 53 | "id": 123, // ID of the app 54 | "sections": [{ 55 | "title": "Overview", 56 | "query_path": "overview" 57 | }, { 58 | "title": "Settings", 59 | "query_path": "settings" 60 | }] 61 | } 62 | }] 63 | ``` 64 | 65 | ## Resources 66 | * [Building Apps Guide](/docs/integrations/apps) 67 | * [Building Channel Apps](/docs/integrations/channels/guide) 68 | * [Extending Existing Apps with Channels Toolkit](/docs/integrations/channels/guide/extending-existing-apps) 69 | -------------------------------------------------------------------------------- /docs/api-docs/apps/tutorials/sample-app-next/heroku-deploy.mdx: -------------------------------------------------------------------------------- 1 | # Quick Start: Deploy to Heroku Install Flow 2 | 3 | If you want to skip the tutorial and get the app running quickly, you can use this install flow to deploy the sample app to [Heroku](https://www.heroku.com/home). To create a Heroku account, visit the [Heroku signup page](https://signup.heroku.com/). 4 | 5 | 6 | ### Fork the repo 7 | 8 | Fork the BigCommerce's [sample-app-nodejs](https://github.com/bigcommerce/sample-app-nodejs) repository. 9 | 10 | ### Click deploy 11 | 12 | In your fork, locate the `README.md` file. Click **Deploy to Heroku**. This will open Heroku's [Create New App](https://dashboard.heroku.com/) page in your browser. 13 | 14 | ![Deploy to Heroku](https://storage.googleapis.com/bigcommerce-production-dev-center/images/Sample_app/nextjs-app-heroku-1.png "Deploy to Heroku") 15 | 16 | ### Heroku: add app details 17 | 18 | When prompted, fill out your app details including giving your app a name. 19 | 20 | Scroll down to **Config Vars** and replace the `` placeholder inside `AUTH_CALLBACK` with your app's name. 21 | 22 | ### BC DevTools: Create an app profile 23 | 24 | To obtain the client ID and client secret, sign in to the [Developer Portal](https://devtools.bigcommerce.com/my/apps) and click **Create an app**. Name the app and click **Create**. For now, click **Close** to continue without entering information. 25 | 26 | ![Create an App](https://storage.googleapis.com/bigcommerce-production-dev-center/images/Sample_app/nextjs-app-03.png "Create an App") 27 | 28 | ### Add the app API account to Heroku 29 | 30 | On the My Apps page of the BC Developer Portal, locate your newly created app and click **View Client ID**. This will open a new window displaying your client ID and client secret. 31 | 32 | Copy and paste your app's client ID and client secret into your Heroku app. 33 | 34 | ### Heroku: Deploy app server 35 | 36 | Click **Deploy app** at the bottom of Heroku's Create New App page. Wait for the deploy script to finish running. 37 | 38 | ![Deploy app](https://storage.googleapis.com/bigcommerce-production-dev-center/images/Sample_app/nextjs-app-heroku-2.png "Deploy app") 39 | 40 | ### BC DevTools: Add Heroku callback URLs 41 | 42 | 1. In the Developer Portal, click **Edit App**. 43 | 2. Open the **Technical** tab. Select STORE OWNER for **Multiple Users** and SINGLE-CLICK for **App Type**. 44 | 3. Scroll down to **Callback URLs** and update Auth, Load, and Uninstall URLs, replacing placeholders with your Heroku app URL. For example, your Auth Callback should look similar to the following: `https://heroku-sample-app.herokuapp.com/api/auth`. 45 | 4. Scroll down to OAuth scopes and set the **Products** access to MODIFY. 46 | 5. Click **Update & Close**. 47 | 48 | ### Install the app on your sandbox 49 | 50 | In your sandbox store control panel, go to **Apps** > **My Apps** > **My Draft Apps**. Open your app and press **Install**. Click **Confirm**. This will install the app on your store. The installed app should look similar to the following: 51 | 52 | **Home page** 53 | 54 | ![Home page](https://storage.googleapis.com/bigcommerce-production-dev-center/images/Sample_app/nextjs-app-16.png "Home page") 55 | 56 | **Products page** 57 | 58 | ![Products page](https://storage.googleapis.com/bigcommerce-production-dev-center/images/Sample_app/nextjs-app-14.png "Products page") 59 | 60 | **Product page** 61 | 62 | ![Product page](https://storage.googleapis.com/bigcommerce-production-dev-center/images/Sample_app/nextjs-app-17.png "Product page") 63 | 64 | 65 | -------------------------------------------------------------------------------- /docs/api-docs/apps/tutorials/sample-app-next/introduction.mdx: -------------------------------------------------------------------------------- 1 | # Introduction 2 | 3 | 4 | 5 | This tutorial demonstrates how to build and embed a BigCommerce app using Node.js, React.js, Next.js, and BigDesign, BigCommerce's library of React components. 6 | 7 | You will learn how to connect your app to BigCommerce, integrate an API, and set up a database to store app data. You will use BigDesign to give your app a native BigCommerce visual style and behavior. 8 | 9 | At the end of this tutorial, you will have a functional single-click app that can make API calls and store app data in a database. 10 | 11 | 12 | #### Heroku option 13 | To get the app up and running quickly, follow the steps described in [Quick Start: Deploy to Heroku Install Flow](/docs/integrations/apps/tutorial/nextjs-quick-start). 14 | 15 | 16 | 17 | ## Prerequisites 18 | 19 | To successfully complete this tutorial, you need the following: 20 | 21 | * Experience using a text editor and a terminal app 22 | * Experience with [Node.js](https://nodejs.org/en/), [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript), and [React.js](https://www.reactjs.org/) 23 | * Experience using [npm](https://www.npmjs.com/) 24 | * [BigCommerce sandbox store](/docs/start/about/sandboxes) (required to develop and test apps) 25 | * [Developer Portal Account](https://devtools.bigcommerce.com/) (required to register apps) 26 | 27 | You will be using [Next.js](https://nextjs.org/), [BigDesign](https://developer.bigcommerce.com/big-design), and [styled-components](https://styled-components.com/docs) to build this sample app. 28 | 29 | [Next.js](https://nextjs.org/) is a production-ready React framework equipped with many built-in features that allows you to create static and dynamic React-based applications quickly. Next.js handles a lot of the backend work for you giving you a jump start on building applications. Among other built-in features, Next.js comes with a [page-based](https://nextjs.org/docs/basic-features/pages) routing system, [server-side rendering](https://nextjs.org/docs/basic-features/pages#server-side-rendering), and [client-side routing](https://nextjs.org/docs/routing/introduction#linking-between-pages). 30 | 31 | With the exception of automated routing, our sample app is very React-ive. Even if you haven't worked with Next.js before, having React experience will enable you to read the app. 32 | 33 | [BigDesign](https://developer.bigcommerce.com/big-design) is a BigCommerce library of React components. Using BigDesign when developing your BigCommerce apps will ensure that your app has a similar interface and adheres to the same user experience standards as the rest of the BigCommerce platform. We encourage you to familiarize yourself with BigDesign to simplify future integrations with BigCommerce. 34 | 35 | [Next: Set up Your Local Environment](/docs/integrations/apps/tutorial/nextjs-setup) 36 | -------------------------------------------------------------------------------- /docs/api-docs/building-storefronts/nextjs-bigcommerce.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Next.js + BigCommerce 3 | keywords: headless, storefronts, next.js, vercel, commerce, shopify, 4 | --- 5 | 6 | # Next.js + BigCommerce 7 | 8 | This article is about the Next.js + BigCommerce starter app, a BigCommerce-optimized version of Vercel's Next.js Commerce v2. 9 | 10 | If you're looking for Next.js Commerce v1, you can learn more in our [legacy storefront documentation](/archive/storefront/nextjs-commerce). 11 | 12 | ## Features 13 | 14 | Next.js + BigCommerce is a Next.js 13 and App Router-ready headless storefront template, featuring the following: 15 | 16 | - [Next.js App Router](https://nextjs.org/docs/app) 17 | - Optimized for SEO using [Next.js's Metadata](https://nextjs.org/docs/app/building-your-application/optimizing/metadata) 18 | - [React Server Components (RSCs)](https://react.dev/blog/2023/03/22/react-labs-what-we-have-been-working-on-march-2023#react-server-components) and [Suspense](https://react.dev/blog/2022/03/29/react-v18#suspense-in-data-frameworks) 19 | - Route handlers for mutations 20 | - Edge runtime 21 | - New fetching and caching paradigms 22 | - Dynamic OG images 23 | - Styling with [Tailwind CSS](https://tailwindcss.com/) 24 | - Automatic light/dark mode based on system settings 25 | 26 | ## Prerequisites 27 | 28 | Next.js + BigCommerce requires a [BigCommerce sandbox](/docs/start/about/sandboxes) or a [production store provisioned to run a headless storefront](https://www.bigcommerce.com/solutions/multi-store/). 29 | 30 | ## Getting started 31 | 32 | To get started, visit the [Next.js + BigCommerce repository (GitHub)](https://github.com/bigcommerce/nextjs-commerce). Use the [README](https://github.com/bigcommerce/nextjs-commerce/blob/main/README.md) and [Example environment variables file](https://github.com/bigcommerce/nextjs-commerce/blob/main/.env.example) to get oriented. You can use the [Deploy with Vercel button (GitHub)](https://github.com/bigcommerce/nextjs-commerce) at the top of the README to configure Vercel environment variables and deploy your storefront, then use the [Vercel CLI (Vercel)](https://vercel.com/docs/cli) to develop locally and see your changes in deployment at will. 33 | 34 | ## Resources 35 | 36 | ### BigCommerce 37 | 38 | - [Get a BigCommerce sandbox](/docs/start/about/sandboxes) 39 | - [Headless Multi-Storefront solutions](https://www.bigcommerce.com/solutions/multi-store/) 40 | - [Next.js + BigCommerce repository (GitHub)](https://github.com/bigcommerce/nextjs-commerce) 41 | - [README](https://github.com/bigcommerce/nextjs-commerce/blob/main/README.md) 42 | - [Example environment variables file](https://github.com/bigcommerce/nextjs-commerce/blob/main/.env.example) 43 | - [Button to deploy Next.js + BigCommerce with Vercel (GitHub)](https://github.com/bigcommerce/nextjs-commerce) 44 | - [Legacy storefront documentation](/archive/storefront/nextjs-commerce) 45 | 46 | ### External 47 | 48 | - [Vercel CLI](https://vercel.com/docs/cli) 49 | - [Next.js App Router](https://nextjs.org/docs/app) 50 | - [Next.js Metadata](https://nextjs.org/docs/app/building-your-application/optimizing/metadata) 51 | - [React Server Components (RSCs)](https://react.dev/blog/2023/03/22/react-labs-what-we-have-been-working-on-march-2023#react-server-components) 52 | - [Suspense](https://react.dev/blog/2022/03/29/react-v18#suspense-in-data-frameworks) 53 | - [Tailwind CSS](https://tailwindcss.com/) 54 | -------------------------------------------------------------------------------- /docs/api-docs/capture/capture.mdx: -------------------------------------------------------------------------------- 1 | # Capture 2 | 3 | Capture the payment for an order updating the `payment_status` to `capture pending`. 4 | 5 | See the [Capture](/docs/rest-management/transactions/payment-actions#capture) endpoint for OAuth scopes, authorization, request parameters, and response information. 6 | -------------------------------------------------------------------------------- /docs/api-docs/cart-and-checkout/embedded-checkout-overview.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Embedded Checkout Overview 3 | keywords: checkouts, embedded, draft order, invoices, headless, 4 | --- 5 | 6 | # Embedded Checkout Overview 7 | 8 | The [Checkout SDK's embedded-checkout sub-module](https://github.com/bigcommerce/checkout-sdk-js/blob/master/docs/README.md#embedcheckout) can be used to embed [BigCommerce's Optimized One-Page Checkout](https://support.bigcommerce.com/s/article/Optimized-Single-Page-Checkout) into non-native storefronts like WordPress. You can see this in action within the BigCommerce for WordPress plugin, which uses the same process described here as a checkout option for merchants. For more information about the plugin, see [BigCommerce for WordPress](/docs/storefront/wordpress). 9 | 10 | ## How it works 11 | 12 | Embedded Checkout uses an HTML `