Big Commerce Storefront Checkouts

BigCommerce Storefront Checkouts is a feature that provides an optimized and streamlined checkout experience for customers shopping on a BigCommerce online store. This tool allows merchants to customize their checkout process to suit their specific needs, providing options for single-page, multi-page, or modal checkout layouts. By making the checkout process as efficient and user-friendly as possible, BigCommerce Storefront Checkouts helps to reduce cart abandonment and increase conversions.

OpenAPI Specification

storefront-checkouts-openapi-original.yml Raw ↑
openapi: 3.0.1
info:
  title: BigCommerce Storefront Checkouts
  description: >-
    Manage checkout operations and data using front-end JavaScript on
    BigCommerce

    Stencil-powered storefronts.


    For info about API accounts, see our [Guide to API
    Accounts](/docs/start/authentication/api-accounts).
        
    For info about authenticating BigCommerce APIs, see [Authentication and
    Example
    Requests](/docs/start/authentication#same-origin-cors-authentication).
  version: ''
  termsOfService: https://www.bigcommerce.com/terms
  contact:
    name: BigCommerce
    url: https://www.bigcommerce.com
    email: [email protected]
servers:
  - url: https://{store_domain}/api/storefront
    variables:
      store_domain:
        default: your_store.example.com
        description: >-
          The [URL
          authority](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Web_mechanics/What_is_a_URL#authority)
          of the storefront.
tags:
  - name: Checkout
  - name: Checkout Billing Address
  - name: Checkout Cart Items
  - name: Checkout Consignments
  - name: Checkout Coupons
  - name: Checkout Gift Certificates
  - name: Checkout Spam Protection
  - name: Checkout Store Credit
paths:
  /checkouts/{checkoutId}:
    get:
      tags:
        - Checkout
      summary: BigCommerce Get a Checkout
      description: >-
        Returns a *Checkout*.


        The cart ID and checkout ID are the same.


        > #### Note

        > * Substitute your storefront domain for `yourstore.example.com`. 

        > * The Send a Test Request feature is not currently supported for this
        endpoint.  
      operationId: getCheckout
      parameters:
        - name: checkoutId
          in: path
          required: true
          schema:
            type: string
        - name: include
          in: query
          description: |-
            * `cart.lineItems.physicalItems.options` - physical options
            * `cart.lineItems.digitalItems.options` - digital options
            * `cart.lineItems.physicalItems.categoryNames` - physical categories
            * `cart.lineItems.digitalItems.categoryNames` - digital categories
            * `cart.lineItems.customItems.categoryNames` - custom categories
            * `customer` - customer
            * `customer.customerGroup` - customer group
            * `payments` - payments
            * `promotions` - promotions
            * `consignments.availableShippingOptions` - shipping options
          schema:
            type: string
            default: consignments.availableShippingOptions
            enum:
              - cart.lineItems.physicalItems.options
              - cart.lineItems.digitalItems.options
              - cart.lineItems.physicalItems.categoryNames
              - cart.lineItems.digitalItems.categoryNames
              - cart.lineItems.customItems.categoryNames
              - customer
              - customer.customerGroup
              - payments
              - promotions
              - consignments.availableShippingOptions
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkouts_Resp'
              example:
                id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed
                cart:
                  id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed
                  customerId: 18
                  email: [email protected]
                  currency:
                    name: US Dollars
                    code: USD
                    symbol: $
                    decimalPlaces: 2
                  isTaxIncluded: true
                  baseAmount: 7.95
                  discountAmount: 0
                  cartAmount: 7.95
                  coupons: []
                  discounts:
                    - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52
                      discountedAmount: 0
                  lineItems:
                    physicalItems:
                      - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52
                        parentId: {}
                        variantId: 345
                        productId: 174
                        sku: ''
                        name: 1L Le Parfait Jar
                        url: https://{store_domain}/all/1l-le-parfait-jar/
                        quantity: 1
                        brand: OFS
                        isTaxable: true
                        imageUrl: >-
                          https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2
                        discounts: []
                        discountAmount: 0
                        couponAmount: 0
                        originalPrice: 7.95
                        listPrice: 7.95
                        salePrice: 7.95
                        extendedListPrice: 7.95
                        extendedSalePrice: 7.95
                        isShippingRequired: true
                        giftWrapping: {}
                        addedByPromotion: false
                    digitalItems: []
                    giftCertificates: []
                    customItems: []
                  createdTime: '2019-01-10T17:18:00+00:00'
                  updatedTime: '2019-01-10T17:19:47+00:00'
                billingAddress:
                  id: 5c377ead301c2
                  firstName: Dwayne
                  lastName: Cole
                  email: [email protected]
                  company: ''
                  address1: Mauna Kea Access Rd
                  address2: ''
                  city: Hilo
                  stateOrProvince: Hawaii
                  stateOrProvinceCode: HI
                  country: United States
                  countryCode: US
                  postalCode: '96720'
                  phone: '8081234567'
                  customFields: []
                consignments:
                  - id: 5c377ead30ac1
                    shippingCost: 8
                    handlingCost: 0
                    couponDiscounts: []
                    discounts: []
                    lineItemIds:
                      - 243c9ca2-22b4-417a-8b09-b3fc05778b52
                    selectedShippingOption:
                      id: d09e05c0-3788-44df-a1bb-b6d3afdf6841
                      type: shipping_byweight
                      description: Ship by Weight
                      imageUrl: ''
                      cost: 8
                      transitTime: ''
                    address:
                      firstName: Dwayne
                      lastName: Cole
                      email: [email protected]
                      company: ''
                      address1: Mauna Kea Access Rd
                      address2: ''
                      city: Hilo
                      stateOrProvince: Hawaii
                      stateOrProvinceCode: HI
                      country: United States
                      countryCode: US
                      postalCode: '96720'
                      phone: '8081234567'
                      customFields: []
                orderId:
                shippingCostTotal: 8
                shippingCostBeforeDiscount: 8
                handlingCostTotal: 0
                taxTotal: 1.22
                coupons: []
                taxes:
                  - name: Tax
                    amount: 1.22
                subtotal: 7.95
                grandTotal: 15.95
                giftCertificates: []
                createdTime: '2019-01-10T17:18:00+00:00'
                updatedTime: '2019-01-10T17:19:47+00:00'
                customerMessage: ''
        '400':
          description: When a problem arises, returns a generic response.
          content:
            application/json:
              schema:
                title: Checkout Error
                type: object
                properties:
                  errors:
                    type: array
                    description: ''
                    items:
                      title: Error Inner
                      type: object
                      properties:
                        status:
                          type: integer
                          description: ''
                          format: int32
                        title:
                          type: string
                          description: ''
                        type:
                          type: string
                          description: ''
                        detail:
                          type: string
                          description: ''
    put:
      tags:
        - Checkout
      summary: BigCommerce Update Customer Messages
      description: >-
        Updates *Checkout* customer messages.


        **Limits**


        * 2000 character limit


        > #### Note

        > * Substitute your storefront domain for `yourstore.example.com`. 

        > * The Send a Test Request feature is not currently supported for this
        endpoint.  
      operationId: updateCheckout
      parameters:
        - name: checkoutId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/checkout_Put'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkouts_Resp'
              example:
                id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed
                cart:
                  id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed
                  customerId: 18
                  email: [email protected]
                  currency:
                    name: US Dollars
                    code: USD
                    symbol: $
                    decimalPlaces: 2
                  isTaxIncluded: true
                  baseAmount: 7.95
                  discountAmount: 0
                  cartAmount: 7.95
                  coupons: []
                  discounts:
                    - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52
                      discountedAmount: 0
                  lineItems:
                    physicalItems:
                      - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52
                        parentId: {}
                        variantId: 345
                        productId: 174
                        sku: ''
                        name: 1L Le Parfait Jar
                        url: https://{store_domain}/all/1l-le-parfait-jar/
                        quantity: 1
                        brand: OFS
                        isTaxable: true
                        imageUrl: >-
                          https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2
                        discounts: []
                        discountAmount: 0
                        couponAmount: 0
                        originalPrice: 7.95
                        listPrice: 7.95
                        salePrice: 7.95
                        extendedListPrice: 7.95
                        extendedSalePrice: 7.95
                        isShippingRequired: true
                        giftWrapping: {}
                        addedByPromotion: false
                    digitalItems: []
                    giftCertificates: []
                    customItems: []
                  createdTime: '2019-01-10T17:18:00+00:00'
                  updatedTime: '2019-01-10T17:19:47+00:00'
                billingAddress:
                  id: 5c377ead301c2
                  firstName: Dwayne
                  lastName: Cole
                  email: [email protected]
                  company: ''
                  address1: Mauna Kea Access Rd
                  address2: ''
                  city: Hilo
                  stateOrProvince: Hawaii
                  stateOrProvinceCode: HI
                  country: United States
                  countryCode: US
                  postalCode: '96720'
                  phone: '8081234567'
                  customFields: []
                consignments:
                  - id: 5c377ead30ac1
                    shippingCost: 8
                    handlingCost: 0
                    couponDiscounts: []
                    discounts: []
                    lineItemIds:
                      - 243c9ca2-22b4-417a-8b09-b3fc05778b52
                    selectedShippingOption:
                      id: d09e05c0-3788-44df-a1bb-b6d3afdf6841
                      type: shipping_byweight
                      description: Ship by Weight
                      imageUrl: ''
                      cost: 8
                      transitTime: ''
                    address:
                      firstName: Dwayne
                      lastName: Cole
                      email: [email protected]
                      company: ''
                      address1: Mauna Kea Access Rd
                      address2: ''
                      city: Hilo
                      stateOrProvince: Hawaii
                      stateOrProvinceCode: HI
                      country: United States
                      countryCode: US
                      postalCode: '96720'
                      phone: '8081234567'
                      customFields: []
                orderId:
                shippingCostTotal: 8
                shippingCostBeforeDiscount: 8
                handlingCostTotal: 0
                taxTotal: 1.22
                coupons: []
                taxes:
                  - name: Tax
                    amount: 1.22
                subtotal: 7.95
                grandTotal: 15.95
                giftCertificates: []
                createdTime: '2019-01-10T17:18:00+00:00'
                updatedTime: '2019-01-10T17:19:47+00:00'
                customerMessage: ''
      x-codegen-request-body-name: body
  /checkouts/{checkoutId}/carts/{cartId}/items/{itemId}:
    put:
      tags:
        - Checkout Cart Items
      summary: BigCommerce Update a Line Item
      description: >-
        Updates a *Checkout Line Item*. Updates an existing, single line item in
        the cart.


        If a variant needs to be changed or updated, the product will need to be
        removed and re-added to the cart with the correct variants using the
        [Add Cart Line
        Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items)
        endpoint or the [GraphQL Storefront
        API](/docs/storefront/cart-checkout/guide/graphql-storefront).


        > #### Notes

        > * Substitute your storefront domain for `yourstore.example.com`. 

        > * The Send a Test Request feature is not currently supported for this
        endpoint.  

        > * Please note that this API endpoint is not concurrent safe, meaning
        multiple simultaneous requests could result in unexpected and
        inconsistent results.
      operationId: updateCheckoutLineItem
      parameters:
        - name: checkoutId
          in: path
          required: true
          schema:
            type: string
        - name: cartId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: itemId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cart_Put'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkout_Full'
              example:
                id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed
                cart:
                  id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed
                  customerId: 18
                  email: [email protected]
                  currency:
                    name: US Dollars
                    code: USD
                    symbol: $
                    decimalPlaces: 2
                  isTaxIncluded: true
                  baseAmount: 7.95
                  discountAmount: 0
                  cartAmount: 7.95
                  coupons: []
                  discounts:
                    - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52
                      discountedAmount: 0
                  lineItems:
                    physicalItems:
                      - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52
                        parentId: {}
                        variantId: 345
                        productId: 174
                        sku: ''
                        name: 1L Le Parfait Jar
                        url: https://{store_domain}/all/1l-le-parfait-jar/
                        quantity: 1
                        brand: OFS
                        isTaxable: true
                        imageUrl: >-
                          https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2
                        discounts: []
                        discountAmount: 0
                        couponAmount: 0
                        originalPrice: 7.95
                        listPrice: 7.95
                        salePrice: 7.95
                        extendedListPrice: 7.95
                        extendedSalePrice: 7.95
                        isShippingRequired: true
                        giftWrapping: {}
                        addedByPromotion: false
                    digitalItems: []
                    giftCertificates: []
                    customItems: []
                  createdTime: '2019-01-10T17:18:00+00:00'
                  updatedTime: '2019-01-10T17:19:47+00:00'
                billingAddress:
                  id: 5c377ead301c2
                  firstName: Dwayne
                  lastName: Cole
                  email: [email protected]
                  company: ''
                  address1: Mauna Kea Access Rd
                  address2: ''
                  city: Hilo
                  stateOrProvince: Hawaii
                  stateOrProvinceCode: HI
                  country: United States
                  countryCode: US
                  postalCode: '96720'
                  phone: '8081234567'
                  customFields: []
                consignments:
                  - id: 5c377ead30ac1
                    shippingCost: 8
                    handlingCost: 0
                    couponDiscounts: []
                    discounts: []
                    lineItemIds:
                      - 243c9ca2-22b4-417a-8b09-b3fc05778b52
                    selectedShippingOption:
                      id: d09e05c0-3788-44df-a1bb-b6d3afdf6841
                      type: shipping_byweight
                      description: Ship by Weight
                      imageUrl: ''
                      cost: 8
                      transitTime: ''
                    address:
                      firstName: Dwayne
                      lastName: Cole
                      email: [email protected]
                      company: ''
                      address1: Mauna Kea Access Rd
                      address2: ''
                      city: Hilo
                      stateOrProvince: Hawaii
                      stateOrProvinceCode: HI
                      country: United States
                      countryCode: US
                      postalCode: '96720'
                      phone: '8081234567'
                      customFields: []
                orderId:
                shippingCostTotal: 8
                shippingCostBeforeDiscount: 8
                handlingCostTotal: 0
                taxTotal: 1.22
                coupons: []
                taxes:
                  - name: Tax
                    amount: 1.22
                subtotal: 7.95
                grandTotal: 15.95
                giftCertificates: []
                createdTime: '2019-01-10T17:18:00+00:00'
                updatedTime: '2019-01-10T17:19:47+00:00'
                customerMessage: ''
      x-codegen-request-body-name: body
    delete:
      tags:
        - Checkout Cart Items
      summary: BigCommerce Delete a Line Item
      description: >-
        Deletes a *Line Item* from the *Cart*.


        > #### Note

        > * Substitute your storefront domain for `yourstore.example.com`. 

        > * The Send a Test Request feature is not currently supported for this
        endpoint.  
      operationId: deleteCheckoutLineItem
      parameters:
        - name: checkoutId
          in: path
          required: true
          schema:
            type: string
        - name: cartId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: itemId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            NOTE: Discounted line items are re-evaluated on cart actions and may
            be automatically added back to your cart with a new line item ID to
            satisfy promotional requirements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkout_Full'
              example:
                id: b6fbd994-61a8-4f25-9167-6ec10489c448
                cart:
                  id: b6fbd994-61a8-4f25-9167-6ec10489c448
                  customerId: 11
                  email: [email protected]
                  currency:
                    name: US Dollars
                    code: USD
                    symbol: $
                    decimalPlaces: 2
                  isTaxIncluded: false
                  baseAmount: 119.93
                  discountAmount: 0
                  cartAmount: 112.93
                  coupons:
                    - id: 1
                      code: S2549JM0Y
                      displayName: $5.00 off the order total
                      couponType: per_total_discount
                      discountedAmount: 5
                  discounts:
                    - id: 69791a88-85c9-4c19-8042-e537621e8a55
                      discountedAmount: 2.59
                    - id: ba2c619d-e6b4-48c2-8809-d88e424ed450
                      discountedAmount: 1.06
                    - id: c72d6651-978d-45e5-881b-c2bb5f7ff1d5
                      discountedAmount: 2.12
                    - id: 6477a4a1-02cf-4287-8bf2-fd043bdd5234
                      discountedAmount: 0.8
                    - id: 871f1f56-4c88-43c3-a6e5-0a647d83d6ac
                      discountedAmount: 0.43
                  lineItems:
                    physicalItems:
                      - id: 69791a88-85c9-4c19-8042-e537621e8a55
                        parentId: {}
                        variantId: 364
                        productId: 184
                        sku: SMA-RED
                        name: Canvas Laundry Cart
                        url: https://{store_domain}/all/canvas-laundry-cart/
                        quantity: 1
                        isTaxable: true
                        imageUrl: >-
                          https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2
                        discounts:
                          - id: total-coupon
                            discountedAmount: 0.59
                          - id: 2
                            discountedAmount: 2
                        discountAmount: 2
                        couponAmount: 0
                        originalPrice: 17.99
                        listPrice: 15.99
                        salePrice: 13.99
                        extendedListPrice: 15.99
                        extendedSalePrice: 13.99
                        isShippingRequired: true
                        giftWrapping: {}
                        addedByPromotion: false
                      - id: ba2c619d-e6b4-48c2-8809-d88e424ed450
                        parentId: {}
                        variantId: 341
                        productId: 170
                        sku: ''
                        name: Ceramic Measuring Spoons
                        url: https://{store_domain}/all/ceramic-measuring-spoons/
                        quantity: 1
                        isTaxable: true
                        imageUrl: >-
                          https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2
                        discounts:
                          - id: total-coupon
                            discountedAmount: 1.06
                        discountAmount: 0
                        couponAmount: 0
                        originalPrice: 25
                        listPrice: 25
                        salePrice: 25
                        extendedListPrice: 25
                        extendedSalePrice: 25
                        isShippingRequired: true
                        giftWrapping: {}
                        addedByPromotion: false
                      - id: c72d6651-978d-45e5-881b-c2bb5f7ff1d5
                        parentId: {}
                        variantId: 376
                        productId: 158
                        sku: SKU-A0C8A203
                        name: Chambray Towel
                        url: https://{store_domain}/all/chambray-towel/
                        quantity: 1
                        isTaxable: true
                        imageUrl: >-
                          https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2
                        discounts:
                          - id: total-coupon
                            discountedAmount: 2.12
                        discountAmount: 0
                        couponAmount: 0
                        originalPrice: 49.99
                        listPrice: 49.99
                        salePrice: 49.99
                        extendedListPrice: 49.99
                        extendedSalePrice: 49.99
                        isShippingRequired: true
                        giftWrapping: {}
                        addedByPromotion: false
                    digitalItems:
                      - id: 6477a4a1-02cf-4287-8bf2-fd043bdd5234
                        parentId: {}
                        variantId: 360
                        productId: 189
                        name: Gather Journal Issue 7 - Digital
                        url: https://{store_domain}/all/gather-journal-issue-7/
                        quantity: 1
                        isTaxable: true
                        imageUrl: >-
                          https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2
                        discounts:
                          - id: total-coupon
                            discountedAmount: 0.8
                        discountAmount: 0
                        couponAmount: 0
                        originalPrice: 18.95
                        listPrice: 18.95
                        salePrice: 18.95
                        extendedListPrice: 18.95
                        extendedSalePrice: 18.95
                        isShippingRequired: false
                        type: digital
                    giftCertificates:
                      - id: 871f1f56-4c88-43c3-a6e5-0a647d83d6ac
                        name: $10.00 Gift Certificate
                        theme: Celebration
                        amount: 10
                        taxable: false
                        sender:
                          name: Jane Doe
                          email: [email protected]
                        recipient:
                          name: John Doe
                          email: [email protected]
                        message: Thank you!
                        type: giftCertificate
                  createdTime: '2018-09-18T15:48:26+00:00'
                  updatedTime: '2018-09-18T16:59:45+00:00'
                billingAddress:
                  id: 5ba11e4a10fb5
                  firstName: Jane
                  lastName: Doe
                  email: [email protected]
                  company: ''
                  address1: 123 Main Street
                  address2: ''
                  city: Austin
                  stateOrProvince: Texas
                  stateOrProvinceCode: TX
                  country: United States
                  countryCode: US
                  postalCode: '78751'
                  phone: '1234567890'
                  customFields:
                    - fieldId: field_25
                      fieldValue: Leave in backyard
                consignments:
                  - id: 5ba121929619b
                    shippingCost: 69.94
                    handlingCost: 0
                    couponDiscounts: []
                    discounts: []
                    lineItemIds:
                      - 69791a88-85c9-4c19-8042-e537621e8a55
                      - ba2c619d-e6b4-48c2-8809-d88e424ed450
                      - c72d6651-978d-45e5-881b-c2bb5f7ff1d5
                    selectedShippingOption:
                      id: bb3c818f-17ce-46fe-9475-65933095da0d
                      type: shipping_upsready
                      description: UPS® (UPS Next Day Air®)
                      imageUrl: ''
                      cost: 69.94
                      transitTime: 1 business day
                    address:
                      firstName: Jane
                      lastName: Doe
                      email: [email protected]
                      company: ''
                      address1: 123 Main Street
                      address2: ''
                      city: Austin
                      stateOrProvince: Texas
                      stateOrProvinceCode: TX
                      country: United States
                      countryCode: US
                      postalCode: '78751'
                      phone: '1234567890'
                      customFields:
                        - fieldId: field_25
                          fieldValue: Leave in backyard
                orderId:
                shippingCostTotal: 69.94
                shippingCostBeforeDiscount: 69.94
                handlingCostTotal: 0
                taxTotal: 28.62
                coupons:
                  - id: 1
                    code: S2549JM0Y
                    displayName: $5.00 off the order total
                    couponType: 2
                    discountedAmount: 5
                taxes:
                  - name: Store Tax
                    amount: 28.62
                subtotal: 117.93
                grandTotal: 211.49
                giftCertificates: []
                createdTime: '2018-09-18T15:48:26+00:00'
                updatedTime: '2018-09-18T16:59:45+00:00'
                customerMessage: Thank you, BigCommerce
  /checkouts/{checkoutId}/billing-address:
    post:
      tags:
        - Checkout Billing Address
      summary: BigCommerce Add Checkout Billing Address
      description: >-
        Adds a billing address to an existing *Checkout*.


        **Required Fields**

        * country_code



        > #### Note

        > * The `email` property is only required if the customer is a guest
        shopper. Otherwise, it is set automatically.

        > * Sending `email` property as a payload in POST request triggers the
        abandoned cart notification process.

        > * Substitute your storefront domain for `yourstore.example.com`. 

        > * The Send a Test Request feature is not currently supported for this
        endpoint.  
      operationId: addCheckoutBillingAddress
      parameters:
        - name: checkoutId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/address_Base'
        required: true
      responses:
        '200':
          description: ''
  

# --- truncated at 32 KB (172 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bigcommerce/refs/heads/main/openapi/storefront-checkouts-openapi-original.yml