openapi: 3.1.0
info:
  title: B2B Storefront
  version: 1.0.0
paths:
  /v2/login:
    post:
      operationId: post-login
      summary: Get Storefront authToken Within Stencil
      description: >-
        Uses a [JSON web token](/developer/docs/storefront/guides/customer-authentication/current-customer) (JWT) from a
        particular customer or Company user who is currently logged in to the storefront to create a storefront
        authToken for future requests. 


        To learn more about how you can retrieve a JWT to create a storefront authToken. See [Authentication for hosted
        storefronts](/developer/docs/b2b-edition/getting-started/authentication).


        Equivalent Storefront GraphQL API Mutation: `authorization`.


        ### Example GraphQL API Body

        ``` graphQL copy

        mutation {
          authorization(
            authData: {
              bcToken: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6ImtpZG8yNzZAc25hcG1haWwuY2MiLCJzdG9yZV9oYXNoIjoiMWk2enB4cGUzZyIsImRiIjoiZGVmYXVsdCIsIm5hbWUiOiJ0ZXN0OSIsImNoYW5uZWxfaWRzIjpbMV0sInRva2VuX3R5cGUiOjMsIm5iZiI6MTAwMCwiZXhwIjoyMDAxfQ.EiR__LVAlBVNYtFCZPWJYoPv6UfGiXtULxhK-BCQZjY",
              channelId: 1
            }
          ) {
            result {
              token
            }
          }
        }

        ```

        ### Example GraphQL API Response

        ``` json copy

        {
          "data": {
            "authorization": {
              "result": {
                "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6ImtpZG8yNzZAc25hcG1haWwuY2MiLCJzdG9yZV9oYXNoIjoiMWk2enB4cGUzZyIsImRiIjoiZGVmYXVsdCIsIm5hbWUiOiJ0ZXN0OSIsImNoYW5uZWxfaWRzIjpbMV0sInRva2VuX3R5cGUiOjMsIm5iZiI6MTAwMCwiZXhwIjoyMDAxfQ.EiR__LVAlBVNYtFCZPWJYoPv6UfGiXtULxhK-BCQZjY"
              }
            }
          }
        }

        ```
      tags:
        - authentication
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Authentication_post-login_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                bcToken:
                  type: string
                  description: >-
                    The JSON Web Token (JWT) obtained from a signed-in Company user. See [Current Customer
                    API](/developer/docs/storefront/guides/customer-authentication/current-customer) to learn how to
                    request a JWT.
                storeHash:
                  $ref: '#/components/schemas/storeHash'
                channelId:
                  $ref: '#/components/schemas/channelId'
                  default: 1
                customerId:
                  type: integer
                  description: The BigCommerce customer ID associated with a Company user.
              required:
                - bcToken
  /io/auth/customers:
    post:
      operationId: post-auth-customer
      summary: Get Storefront authToken for Specific Customer
      description: >-
        Validates a Company user’s login credentials to create a storefront authToken that can be queried for future
        GraphQL requests.


        Equivalent Storefront GraphQL API Mutation: `login`


        The GraphQL API mutation also allows you to return a `storefrontLoginToken`. This retrieves a JWT, which can be
        passed to the BigCommerce [Customer Login
        endpoint](/developer/docs/storefront/guides/customer-authentication/customer-login) in order to log a customer
        in with a Stencil storefront session.


        The `login` response also includes information related to the Company user, such as their name and their
        account’s internal identifiers.


        **Note:** the resulting storefront authToken is tied to the Company user, and their assigned user role
        determines whether or not further requests are authorized. For example, if you generate an authToken for a user
        who does not have the `create_address` permission enabled, using the token to validate the GraphQL API
        `addressCreate` mutation will result in an error.  


        For a complete list of Company user permissions and their scopes, see [Company Roles and
        Permissions](/developer/api-reference/rest/b2b/management/company/company-roles-and-permissions).


        ### Example GraphQL API Body


        **With Storefront authToken only**


        ``` graphQL copy

        mutation {
          login(
            loginData: {
              storeHash: "1234abcd",
              email: "axe@snapmail.cc",
              password: "MyPassword123"
            }
          ) {
            result {
              token
              user {
                id
                bcId
                firstName
                lastName
                email
              }
            }
          }
        }

        ```


        **With Storefront authToken and storefrontLoginToken**


        ``` graphQL copy

        mutation {
          login(
            loginData: {
              storeHash: "1234abcd",
              email: "axe@snapmail.cc",
              password: "MyPassword123"
            }
          ) {
            result {
              token
              storefrontLoginToken
              user {
                id
                bcId
                firstName
                lastName
                email
              }
            }
          }
        }

        ```


        ### Example GraphQL API Responses


        **With Storefront authToken only**


        ``` json copy

        {
          "data": {
            "login": {
              "result": {
                "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6InRlc3RfYjJjX29yZGVyX2ltcG9ydEBxcS5jb21tIiwic3RvcmVfaGFzaCI6ImYyb3N4ampueGoiLCJkYiI6ImRlZmF1bHQifQ",
                "user": {
                  "id": "8889911",
                  "bcId": 28,
                  "firstName": "B2B",
                  "lastName": "User",
                  "email": "user@example.com"
                }
              }
            }
          }
        }

        ```


        **With Storefront authToken and storefrontLoginToken**


        ``` json copy

        {
          "data": {
            "login": {
              "result": {
                "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6InRlc3RfYjJjX29yZGVyX2ltcG9ydEBxcS5jb21tIiwic3RvcmVfaGFzaCI6ImYyb3N4ampueGoiLCJkYiI6ImRlZmF1bHQifQ",
                "storefrontLoginToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6ImtpZG8yNzZAc25hcG1haWwuY2MiLCJzdG9yZV9oYXNoIjoiMWk2enB4cGUzZyIsImRiIjoiZGVmYXVsdCIsIm5hbWUiOiJ0ZXN0OSIsImNoYW5uZWxfaWRzIjpbMV0sInRva2VuX3R5cGUiOjMsIm5iZiI6MTAwMCwiZXhwIjoyMDAxfQ.EiR__LVAlBVNYtFCZPWJYoPv6UfGiXtULxhK-BCQZjY",
                "user": {
                  "id": "8889911",
                  "bcId": 28,
                  "firstName": "B2B",
                  "lastName": "User",
                  "email": "user@example.com"
                }
              }
            }
          }
        }

        ```
      tags:
        - authentication
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Authentication_post-auth-customer_Response_200'
        '400':
          description: 400 - Auth Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post-auth-customerRequestBadRequestError'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                storeHash:
                  $ref: '#/components/schemas/storeHash'
                channelId:
                  $ref: '#/components/schemas/channelId'
                name:
                  type: string
                  description: The internal name assigned to the generated storefront authToken.
                email:
                  type: string
                  format: email
                  description: The email address associated with the user's account.
                password:
                  type: string
                  format: password
                  description: The password associated with the user's account.
                beginAt:
                  type: integer
                  description: >-
                    The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the storefront authToken starts
                    being valid.
                endAt:
                  type: integer
                  description: >-
                    The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the storefront authToken is no
                    longer valid.
              required:
                - storeHash
                - channelId
                - name
                - email
                - password
  /catalogs/variants:
    get:
      operationId: get-catalogs-variants
      summary: Get Product Variants Info
      description: >-
        Returns a list of variants associated with the product identified by the `productId` parameter.


        Analogous to the [Get all product
        variants](/developer/api-reference/rest/admin/catalog/product-variants/get-product-variants) endpoint in the
        default BigCommerce API.


        Equivalent Storefront GraphQL API Query: `productVariantsInfo`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - catalog
      parameters:
        - name: productId
          in: query
          description: The unique product ID as assigned by BigCommerce.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Catalog_get-catalogs-variants_Response_200'
  /catalogs/quick-product:
    get:
      operationId: get-catalogs-quickProduct
      summary: Get Variant Information
      description: >-
        Returns detailed information for each product variant provided in the `variantSkus` parameter. Several fields
        are duplicated in other formats for convenience.


        Analogous to the [Get a product
        variant](/developer/api-reference/rest/admin/catalog/product-variants/get-product-variant) endpoint in the
        default BigCommerce API. 


        Equivalent Storefront GraphQL API Query: `variantSku`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - catalog
      parameters:
        - name: variantSkus
          in: query
          description: A collection of SKUs associated with product variants, separated by `|`.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Catalog_get-catalogs-quickProduct_Response_200'
  /catalogs/quick-order-pad:
    post:
      operationId: post-catalogs-quick-order-pad
      summary: Get Detailed Variant Information
      description: >-
        Returns detailed information about the variants whose SKUs are provided in the body of the request. This
        includes the information from [Get Variant Information](#get-variant-information) as well as other variant data
        that may affect pricing, availability, and other factors.


        Details provided in the response body are sufficient to quickly add a product to a cart or a quote using
        appropriate methods.


        > Note: This endpoint uses the `POST` method, despite its use to only *retrieve* information. Using the `GET`
        method with this endpoint will return a `200` status, but the `data` field will be empty. Likewise, using `POST`
        with this endpoint with an empty body will return an empty `data` field.


        Equivalent Storefront GraphQL API Query: `variantSku`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - catalog
      parameters:
        - name: currencyCode
          in: query
          description: >-
            The three-letter currency code to use in price calculation. If not provided, defaults to the store's default
            currency.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuickVariantInfoResponse'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                variantSkus:
                  type: array
                  items:
                    type: string
                  description: >-
                    List of variant SKUs for which to fetch detailed information. If this is omitted, the response will
                    be empty.
  /companies/addresses/countries:
    get:
      operationId: get-companies-addresses-countries
      summary: List Countries
      description: >-
        Returns a list of **all** countries and, if applicable, their states. The response includes the name and code of
        each returned element and the id of each country.


        **NOTE:** Due to the size of the list returned, the results should be cached for continued use, if possible.


        Equivalent Storefront GraphQL API Query: `countries`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - addresses
      parameters:
        - name: storeHash
          in: query
          description: The unique alphanumeric store hash for the BigCommerce store.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Addresses_get-companies-addresses-countries_Response_200'
  /companies/addresses/permission:
    get:
      operationId: get-companies-addresses-permission
      summary: Get Address Edit Permission
      description: >-
        Checks whether or not the storefront allows Company users to modify addresses. This corresponds with the Address
        book management settings in the B2B Edition control panel. See [B2B Edition
        Settings](https://support.bigcommerce.com/s/article/B2B-Edition-Settings) in the Help Center to learn more.


        Equivalent Storefront GraphQL API Query: `addressConfig`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - addresses
      parameters:
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Addresses_get-companies-addresses-permission_Response_200'
  /companies/{companyId}/addresses:
    get:
      operationId: get-companies-companyId-addresses
      summary: List Company Addresses
      description: >-
        Returns the billing and shipping addresses associated with a particular Company account.


        Equivalent Storefront GraphQL API Query: `addresses`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - addresses
      parameters:
        - name: companyId
          in: path
          description: The unique numeric ID of the Company account.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Addresses_get-companies-companyId-addresses_Response_200'
    post:
      operationId: post-companies-companyId-addresses
      summary: Create Company Address
      description: >-
        Creates an address for a Company account, if address book management is enabled for your storefront. You can
        designate whether the address is for shipping, billing, or both.


        Equivalent Storefront GraphQL API Mutation: `addressCreate`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - addresses
      parameters:
        - name: companyId
          in: path
          description: The unique numeric ID of the Company account.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Addresses_post-companies-companyId-addresses_Response_200'
        '400':
          description: >-
            Bad Request


            This error occurs when the request body fails validation. For example, it occurs when the address `country`
            is one of the countries listed in [Get
            State](/developer/api-reference/rest/b2b/management/addresses/get-addresses-states-state-name-code) but
            `stateName` or `stateCode` is missing, empty, or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post-companies-companyId-addressesRequestBadRequestError'
      requestBody:
        description: Extra Field Values
        content:
          application/json:
            schema:
              type: object
              properties:
                firstName:
                  $ref: '#/components/schemas/addressFirstName'
                isShipping:
                  $ref: '#/components/schemas/isShipping'
                isBilling:
                  $ref: '#/components/schemas/isBilling'
                phoneNumber:
                  $ref: '#/components/schemas/addressPhone'
                addressLine1:
                  type: string
                  description: The first line of the address
                addressLine2:
                  type: string
                  description: The second line of the address
                city:
                  $ref: '#/components/schemas/companyCity'
                zipCode:
                  $ref: '#/components/schemas/zipCode'
                state:
                  $ref: '#/components/schemas/stateObject'
                  description: >-
                    State of the address, as an object with the state name and its two-character code. Required when the
                    address `country` is one of the countries listed in [Get
                    State](/developer/api-reference/rest/b2b/management/addresses/get-addresses-states-state-name-code).
                    Optional otherwise.


                    An empty string for `stateName` or `stateCode` is treated as missing, not as "not provided", so it
                    is rejected the same as omitting the field for a country that requires a state.
                country:
                  $ref: '#/components/schemas/countryObject'
                isDefaultShipping:
                  $ref: '#/components/schemas/isDefaultShipping'
                isDefaultBilling:
                  $ref: '#/components/schemas/isDefaultBilling'
                label:
                  $ref: '#/components/schemas/addressLabel'
                extraFields:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CompaniesCompanyIdAddressesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems
              required:
                - firstName
                - addressLine1
                - city
                - country
  /companies/{companyId}/addresses/searches:
    get:
      operationId: get-companies-companyId-addresses-searches
      summary: Search Company Addresses
      description: >-
        Returns all addresses associated with a Company account that match the query string `q`.


        Equivalent Storefront GraphQL API Query: `addresses`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - addresses
      parameters:
        - name: companyId
          in: path
          description: The unique numeric ID of the Company account.
          required: true
          schema:
            type: string
        - name: q
          in: query
          description: The search string for the request.
          required: false
          schema:
            type: string
        - name: limit
          in: query
          description: The total number of items per page of the response.
          required: true
          schema:
            type: string
        - name: offset
          in: query
          description: The number of items to skip before the current page of the response.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Addresses_get-companies-companyId-addresses-searches_Response_200'
    post:
      operationId: post-companies-companyId-addresses-searches
      summary: Search Addresses with Multiple Filters
      description: >-
        Returns one or more Company addresses based on the filter parameters. You can use this to make refined searches,
        such as locating a particular address by its label or viewing all addresses in a specific country.


        Equivalent Storefront GraphQL API Query: `addresses`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - addresses
      parameters:
        - name: companyId
          in: path
          description: The unique numeric ID of the Company account.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Addresses_post-companies-companyId-addresses-searches_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                filters:
                  $ref: >-
                    #/components/schemas/CompaniesCompanyIdAddressesSearchesPostRequestBodyContentApplicationJsonSchemaFilters
                offset:
                  type: number
                  format: double
                  description: Pagination offset for the results.
                limit:
                  type: number
                  format: double
                  description: Pagination limit for the results.
                q:
                  type: string
                  description: The search string for the request. Its value determines the results returned by the request.
  /companies/{companyId}/addresses/{addressId}:
    get:
      operationId: get-companies-companyId-addresses-addressId
      summary: Get Address
      description: >-
        Returns a specific address based on the `companyId` and `addressId` in the path.


        Equivalent Storefront GraphQL API Query: `address`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - addresses
      parameters:
        - name: companyId
          in: path
          description: The unique numeric ID of the Company account.
          required: true
          schema:
            type: string
        - name: addressId
          in: path
          description: The unique ID of the address.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Addresses_get-companies-companyId-addresses-addressId_Response_200'
    put:
      operationId: put-companies-companyId-addresses-addressId
      summary: Update Address Information
      description: >-
        Updates the details of a billing or shipping address, if address book management is enabled for your storefront.


        Equivalent Storefront GraphQL API Mutation: `addressUpdate`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - addresses
      parameters:
        - name: companyId
          in: path
          description: The unique numeric ID of the Company account.
          required: true
          schema:
            type: string
        - name: addressId
          in: path
          description: The unique ID of the address.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Addresses_put-companies-companyId-addresses-addressId_Response_200'
        '400':
          description: >-
            Bad Request


            This error occurs when the request body fails validation. For example, it occurs when the address `country`
            is one of the countries listed in [Get
            State](/developer/api-reference/rest/b2b/management/addresses/get-addresses-states-state-name-code) but
            `stateName` or `stateCode` is missing, empty, or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Put-companies-companyId-addresses-addressIdRequestBadRequestError'
      requestBody:
        description: Extra Field Values
        content:
          application/json:
            schema:
              type: object
              properties:
                firstName:
                  $ref: '#/components/schemas/addressFirstName'
                isShipping:
                  $ref: '#/components/schemas/isShipping'
                isBilling:
                  $ref: '#/components/schemas/isBilling'
                phoneNumber:
                  $ref: '#/components/schemas/addressPhone'
                addressLine1:
                  type: string
                  description: The first line of the address
                addressLine2:
                  type: string
                  description: The second line of the address
                city:
                  $ref: '#/components/schemas/companyCity'
                zipCode:
                  $ref: '#/components/schemas/zipCode'
                state:
                  $ref: '#/components/schemas/stateObject'
                  description: >-
                    State of the address, as an object with the state name and its two-character code. Required when the
                    address `country` is one of the countries listed in [Get
                    State](/developer/api-reference/rest/b2b/management/addresses/get-addresses-states-state-name-code).
                    Optional otherwise.


                    An empty string for `stateName` or `stateCode` is treated as missing, not as "not provided", so it
                    is rejected the same as omitting the field for a country that requires a state.
                country:
                  $ref: '#/components/schemas/countryObject'
                addressId:
                  $ref: '#/components/schemas/addressId'
                lastName:
                  $ref: '#/components/schemas/addressLastName'
                isDefaultShipping:
                  $ref: '#/components/schemas/isDefaultShipping'
                isDefaultBilling:
                  $ref: '#/components/schemas/isDefaultBilling'
                label:
                  $ref: '#/components/schemas/addressLabel'
                extraFields:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CompaniesCompanyIdAddressesAddressIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems
              required:
                - firstName
                - isShipping
                - isBilling
                - phoneNumber
                - addressLine1
                - addressLine2
                - city
                - zipCode
                - country
                - addressId
                - lastName
                - isDefaultShipping
                - isDefaultBilling
                - label
  /companies/{companyId}/addresses/{addressId}/activation:
    put:
      operationId: put-companies-companyId-addresses-addressId-activation
      summary: Mark Address as Active or Inactive
      description: >-
        Specifies whether or not a Company account can use a particular address on quotes or at checkout.


        Equivalent Storefront GraphQL API Mutation: `addressDelete`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - addresses
      parameters:
        - name: companyId
          in: path
          description: The unique numeric ID of the Company account.
          required: true
          schema:
            type: string
        - name: addressId
          in: path
          description: The unique ID of the address.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Addresses_put-companies-companyId-addresses-addressId-activation_Response_200'
  /companies/{companyId}/default-addresses:
    get:
      operationId: get-companies-companyId-default-addresses
      summary: Get Company Default Addresses
      description: >-
        Returns a Company’s default shipping and billing addresses. Use [Update Address
        Information](#update-address-information) to change which addresses are set as the defaults.


        Equivalent Storefront GraphQL API Query: `defaultBillingAddress` for the billing address and
        `defaultShippingAddress` for the shipping address. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - addresses
      parameters:
        - name: companyId
          in: path
          description: The unique numeric ID of the Company account.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Addresses_get-companies-companyId-default-addresses_Response_200'
  /frontend/companies:
    post:
      operationId: createcompany(frontend)
      summary: Create Company
      description: >-
        Submit a Business Account application on the storefront to create a Company account in the Pending status. This
        is an anonymous operation which does not require a [storefront
        authToken](/developer/api-reference/rest/b2b/storefront/authentication) for a particular customer.


        Equivalent Storefront GraphQL API Mutation: `companyCreate`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).


        > The `registerCompany` mutation in the BigCommerce Storefront GraphQL API also allows you to create a new
        Company account as a storefront customer. See [Company Account
        Registration](/developer/docs/b2b-edition/storefront/graphql-storefront-api/overview) to learn more.


        If you have configured required information fields in your store’s Extra Fields settings for Company accounts or
        Company users, you must include the field’s name and value in the `extraFields` array of the request body. For
        more information on extra fields, see [B2B Edition
        Settings](https://support.bigcommerce.com/s/article/B2B-Edition-Settings) in the Help Center.


        ### Pending Company Accounts


        If your store uses [Independent Companies
        behavior](https://support.bigcommerce.com/s/article/Companies-and-Customer-Groups), buyers with a pending
        Company account cannot log in to the B2C version of the Buyer Portal or view previous orders until you have
        approved or rejected their Company application. Depending on your Company management setting configurations,
        they may also be restricted from viewing products and placing orders.


        When you approve an application, the buyer can log in to the B2B version of the Buyer Portal and view previous
        orders. Rejecting an application restores their access to the B2C version of the Buyer Portal.


        For stores using legacy Dependent Companies behavior, buyers with a pending Company account can still log in to
        the Buyer Portal and view their orders before you have processed their application.


        See [Companies (Help
        Center)](https://support.bigcommerce.com/s/article/B2B-Edition-User-Guide-Company-and-Customer-Functions) to
        learn more about the settings and buyer experience for pending Company accounts.
      tags:
        - companies
      parameters:
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_createcompany(frontend)_Response_200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Createcompany(frontend)RequestBadRequestError'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                companyName:
                  $ref: '#/components/schemas/companyName'
                companyPhoneNumber:
                  $ref: '#/components/schemas/companyPhone'
                companyFirstName:
                  type: string
                  description: The first name of the Company account administrator.
                companyLastName:
                  type: string
                  description: The last name of the Company account administrator.
                customerEmail:
                  $ref: '#/components/schemas/customerEmail'
                customerId:
                  type: string
                  description: The ID of the BigCommerce customer account for the Company account administrator.
                storeHash:
                  type: string
                  description: The unique store hash for the BigCommerce store.
                companyEmail:
                  $ref: '#/components/schemas/email_BASE'
                  description: The primary email address of the company.
                addressLine1:
                  type: string
                  description: The first line of the address
                addressLine2:
                  type: string
                  description: The second line of the address
                city:
                  $ref: '#/components/schemas/companyCity'
                zipCode:
                  $ref: '#/components/schemas/zipCode'
                state:
                  $ref: '#/components/schemas/stateString'
                country:
                  $ref: '#/components/schemas/countryString'
                extraFields:
                  type: array
                  items:
                    $ref: '#/components/schemas/FrontendCompaniesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems'
              required:
                - companyName
                - companyPhoneNumber
                - companyFirstName
                - companyLastName
                - customerEmail
                - customerId
                - storeHash
                - companyEmail
                - addressLine1
                - addressLine2
                - city
                - zipCode
                - state
                - country
  /companies/extra-fields/storefront:
    get:
      operationId: get-companies-extra_fields-storefront
      summary: Get Company Extra Fields
      description: >-
        Returns a list of available extra fields for Company accounts.


        Equivalent Storefront GraphQL API Query: `companyExtraFields`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).


        This request will only return Company extra fields that are configured to be visible on the storefront.
      tags:
        - companies
      parameters:
        - name: storeHash
          in: query
          description: The unique alphanumeric store hash for the BigCommerce store.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_get-companies-extra_fields-storefront_Response_200'
  /customers/{userId}/companies:
    get:
      operationId: getcompanybyuserid
      summary: Get Company by User ID
      description: >-
        Returns information for the Company account that corresponds to the provided user ID.


        Equivalent Storefront GraphQL API Query: `userCompany`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).


        You must use the `userId` value for the Company user to return the correct Company; the `customerId` value of
        the corresponding BigCommerce customer account is not supported.
      tags:
        - companies
      parameters:
        - name: userId
          in: path
          description: The unique ID for the customer account.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_getcompanybyuserid_Response_200'
  /companies/{companyId}/users:
    get:
      operationId: get-companies-companyId-users
      summary: List Company Users
      description: >-
        Returns a list of users associated with a Company account.


        Equivalent Storefront GraphQL API Query: `users`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - companies
      parameters:
        - name: companyId
          in: path
          description: The unique numeric ID of the Company account.
          required: true
          schema:
            type: string
        - name: role[]
          in: query
          description: >-
            The ID of the role assigned to the Company user account as defined at [Specifying User
            Role](/developer/api-reference/rest/b2b/storefront/company/companies#specifying-user-role).
          required: false
          schema:
            $ref: '#/components/schemas/CompaniesCompanyIdUsersGetParametersRole'
        - name: limit
          in: query
          description: The total number of items per page of the response.
          required: false
          schema:
            type: string
            default: '10'
        - name: offset
          in: query
          description: The number of items to skip before the current page of the response.
          required: false
          schema:
            type: string
        - name: q
          in: query
          description: The search string for the request.
          required: false
          schema:
            type: string
        - name: minLastModifiedTime
          in: query
          description: >-
            The earliest [Unix timestamp](https://www.unixtimestamp.com/) for when the Company account was modified that
            can be returned.
          required: false
          schema:
            type: string
        - name: maxLastModifiedTime
          in: query
          description: >-
            The latest [Unix timestamp](https://www.unixtimestamp.com/) for when the Company account was modified that
            can be returned.
          required: false
          schema:
            type: string
        - name: minLastCreatedTime
          in: query
          description: >-
            The earliest [Unix timestamp](https://www.unixtimestamp.com/) for when the Company account was created that
            can be returned.
          required: false
          schema:
            type: string
        - name: maxLastCreatedTime
          in: query
          description: >-
            The earliest [Unix timestamp](https://www.unixtimestamp.com/) for when the Company account was created that
            can be returned.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_get-companies-companyId-users_Response_200'
  /companies/validations/frontend/user-emails/{email}:
    get:
      operationId: get-companies-validations-fronted-user-emails-email
      summary: Validate Frontend User Email
      description: >-
        Checks if an email address is associated with a BigCommerce customer account and a Company user account.


        Equivalent Storefront GraphQL API Query: `userEmailCheck`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).


        The `isValid` value in the response indicates whether or not the email address is used by an existing customer
        or Company user. The following values are possible:


        * `0` — The email address is associated with a Company user account and a corresponding customer account.

        * `1` — The email address is not associated with a customer account or a Company user account.

        * `2` — The email address is associated with a customer account, but not a Company user account.
      tags:
        - companies
      parameters:
        - name: email
          in: path
          description: The email address of the user to be validated.
          required: true
          schema:
            $ref: '#/components/schemas/email_BASE'
        - name: storeHash
          in: query
          description: The unique alphanumeric store hash for the BigCommerce store.
          required: true
          schema:
            type: string
        - name: role
          in: query
          description: |-
            The ID of the role assigned to the Company user account as given below.

            | Value | Code |
            | --- | --- |
            | 0 | Admin |
            | 1 | Senior Buyer |
            | 2 | Junior Buyer |
            | 3 | Super Admin |
            | 4 | Unknown |
          required: true
          schema:
            $ref: '#/components/schemas/CompaniesValidationsFrontendUserEmailsEmailGetParametersRole'
        - name: companyId
          in: query
          description: The unique numeric ID of the Company account.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_get-companies-validations-fronted-user-emails-email_Response_200'
  /users/validations/existence:
    get:
      operationId: get-users-validations-existence
      summary: Check Existence of Customer Email
      description: This endpoint previously validated extra fields for a particular Company user by email address.
      tags:
        - users
      parameters:
        - name: storeHash
          in: query
          description: The unique alphanumeric store hash for the BigCommerce store.
          required: true
          schema:
            type: string
        - name: email
          in: query
          description: The email of the customer to be validated.
          required: true
          schema:
            type: string
        - name: extraFieldName
          in: query
          description: The name of the extra field.
          required: false
          schema:
            type: string
        - name: extraFieldValue
          in: query
          description: The value of the extra field.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users_get-users-validations-existence_Response_200'
  /users:
    get:
      operationId: get-users
      summary: List Users
      description: >-
        Returns a list of a Company’s users by role.


        Equivalent Storefront GraphQL API Query: `users`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).


        The `role` parameter allows you to filter for users that have a predefined Company role. You can also view all
        users in a Company, or users with an unknown role.
      tags:
        - users
      parameters:
        - name: q
          in: query
          description: The search string for the request.
          required: false
          schema:
            type: string
        - name: role
          in: query
          description: |-
            The ID of the role assigned to the Company user account as given below.

            | Value | Code |
            | --- | --- |
            | 0 | Admin |
            | 1 | Senior Buyer |
            | 2 | Junior Buyer |
            | 3 | Super Admin |
            | 4 | Unknown |
          required: true
          schema:
            $ref: '#/components/schemas/UsersGetParametersRole'
        - name: limit
          in: query
          description: The total number of items per page of the response.
          required: false
          schema:
            type: string
            default: '10'
        - name: offset
          in: query
          description: The number of items to skip before the current page of the response.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users_get-users_Response_200'
    post:
      operationId: post-users
      summary: Create User
      description: >-
        Creates a new user in a Company account.


        Equivalent Storefront GraphQL API Mutation: `userCreate`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).


        If you enter an email address in the `email` field that is associated with a BigCommerce customer account, and
        the customer account does not already have a corresponding Company user account, it will link the existing
        customer account with the new Company user. If the email is not associated with a customer account, a new one
        will be created with the Company user.


        This endpoint will send a welcome email to the new user as if they had created their account via the Storefront
        UI.


        When you create an account this way, the user must reset their password to log in to the storefront unless they
        already have an existing BigCommerce customer account.
      tags:
        - users
      parameters:
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users_post-users_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                firstName:
                  $ref: '#/components/schemas/userFirstName'
                lastName:
                  $ref: '#/components/schemas/userLastName'
                email:
                  $ref: '#/components/schemas/userEmail'
                companyId:
                  $ref: '#/components/schemas/companyId'
                phoneNumber:
                  $ref: '#/components/schemas/userPhone'
                role:
                  $ref: '#/components/schemas/userRole'
              required:
                - firstName
                - lastName
                - email
                - companyId
                - phoneNumber
                - role
  /users/{userId}:
    get:
      operationId: get-users-userId
      summary: Get User Information
      description: >-
        Returns Company user information. The `userId` parameter accepts both the Company user ID and the BigCommerce
        customer account ID.


        Equivalent Storefront GraphQL API Query: `user`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - users
      parameters:
        - name: userId
          in: path
          description: The unique ID for the customer account.
          required: true
          schema:
            type: string
        - name: isBcId
          in: query
          description: >-
            Indicates whether the `userId` parameter is the BigCommerce Customer ID. A value of `1` indicates that it
            is.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users_get-users-userId_Response_200'
    put:
      operationId: put-users-userId
      summary: Update User Information
      description: >-
        Updates information about an existing Company user. The `userId` parameter accepts both the Company user ID and
        the BigCommerce customer account ID.


        Equivalent Storefront GraphQL API Mutation: `userUpdate`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - users
      parameters:
        - name: userId
          in: path
          description: The unique ID for the customer account.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users_put-users-userId_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                firstName:
                  $ref: '#/components/schemas/userFirstName'
                lastName:
                  $ref: '#/components/schemas/userLastName'
                email:
                  $ref: '#/components/schemas/userEmail'
                phoneNumber:
                  $ref: '#/components/schemas/userPhone'
                role:
                  $ref: '#/components/schemas/userRole'
              required:
                - firstName
                - lastName
                - email
                - phoneNumber
                - role
    delete:
      operationId: delete-users-userId
      summary: Delete User
      description: >-
        Deletes a Company user.


        Equivalent Storefront GraphQL API Mutation: `userDelete`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - users
      parameters:
        - name: userId
          in: path
          description: The unique ID for the customer account.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users_delete-users-userId_Response_200'
  /orders:
    get:
      operationId: get-orders
      summary: List Orders
      description: >-
        Retrieves information for all orders placed by the Company user.


        Filter the order list using parameters. Common use cases include:


        - Retrieving orders placed within a specific date range (using `beginDateAt` and `endDateAt`)

        - Retrieving orders with a specific Purchase Order (PO) number

        - Retrieving orders in a specific status


        Use [Get Order Details](#get-order-details) to retrieve more detailed information about a specific order, such
        as product attributes, shipping method, and granular pricing.


        Equivalent Storefront GraphQL API Query: `allOrders`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - orders
      parameters:
        - name: beginDateAt
          in: query
          description: >-
            Enter a date in `%m/%d/%Y` format to retrieve all orders placed after that time. If the parameter is not
            included in the request, the resposne includes orders placed 30 days before the current date.
          required: false
          schema:
            type: string
            format: date-time
        - name: endDateAt
          in: query
          description: >-
            Enter a date in `%m/%d/%Y` format to retrieve all orders placed before that time. If the parameter is not
            included in the request, the current date is used.
          required: false
          schema:
            type: string
            format: date-time
        - name: orderBy
          in: query
          description: >-
            Sorts results by total value including tax or creation date. It defaults to the creation date if no
            parameter is provided.
          required: false
          schema:
            $ref: '#/components/schemas/OrdersGetParametersOrderBy'
            default: createdAt
        - name: sortBy
          in: query
          description: >-
            Establish a descending or ascending order of results. The order defaults to descending if the parameter is
            not included.
          required: false
          schema:
            $ref: '#/components/schemas/OrdersGetParametersSortBy'
            default: DESC
        - name: offset
          in: query
          description: The number of results to skip before returning the first result. If left blank, this defaults to 0.
          required: false
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: Determines the number of records to return per page. If left blank, this defaults to 10.
          required: false
          schema:
            type: integer
            default: 10
        - name: isShowMy
          in: query
          description: >-
            Indicates whether or not to include orders placed by other buyers in the Company account. `0` indicates that
            only orders placed by the authenticated user are returned, while `1` indicates that orders placed by other
            buyers in the Company account are also included.


            **Note:** This is only supported if you have generated a storefront authToken for a Company user in the
            predefined **Admin** or **Senior Buyer** role. Junior Buyers, as well as custom buyer roles, are not
            compatible with this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/OrdersGetParametersIsShowMy'
            default: 0
        - name: includeExtra
          in: query
          description: >-
            Indicates whether or not extra field information is included in the response. It defaults to including extra
            fields if the parmeter is omitted. `0` indicates that extra fields are included, while `1` indicates that
            extra fields are not included.
          required: false
          schema:
            $ref: '#/components/schemas/OrdersGetParametersIncludeExtra'
            default: 0
        - name: q
          in: query
          description: >-
            Enter order information to return partial and exact matches. Accepted information fields include order ID,
            order status name, Purchase Order (PO) number, and total order value including tax.
          required: false
          schema:
            type: string
        - name: companyName
          in: query
          description: Enter a full or partial Company name to retrieve relevant orders.
          required: false
          schema:
            type: string
        - name: orderNumber
          in: query
          description: >-
            The BigCommerce order ID. This parameter does not accept the B2B Edition order ID returned in certain
            [Server to Server Orders endpoints](/developer/api-reference/rest/b2b/management/orders).
          required: false
          schema:
            type: integer
        - name: poNumber
          in: query
          description: The order's Purchase Order (PO), if used.
          required: false
          schema:
            type: string
        - name: status[]
          in: query
          description: >-
            Enter the original order status name to return orders in that status. This parameter does not accept custom
            order status names or status codes as valid values. See [Order
            Statuses](/developer/api-reference/rest/admin/management/orders/order-status) for a complete list of
            accepted status names.


            This parameter is not an array, but you can filter for multiple order statuses by including additional
            status[] parameters in the query. For example, `?status[]=Awaiting Payment&status[]=Completed`.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_get-orders_Response_200'
    post:
      operationId: post-orders
      summary: Create Order
      description: >-
        Generates an order record in B2B Edition after a Company user places an order.


        This occurs automatically; however, you can populate extra information on a B2B order by using a
        [webhook](/developer/docs/integrations/webhooks) that first listens for BigCommerce order creation and then
        calls the Create an Order endpoint. The request must be made within 10 seconds of an order's creation for it to
        be successful.


        Note that this  **does not** create a new order in your store. Use the [Orders V2
        API](/developer/api-reference/rest/admin/management/orders) to add new orders via the API.


        Equivalent Storefront GraphQL API Mutation: `createOrder`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - orders
      parameters:
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_post-orders_Response_200'
        '400':
          description: >-
            Bad Request


            This error occurs if the `orderId` value does not correspond to an existing order that was placed by the
            Company user. It can also occur if the storefront authToken used to authenticate the request does not have
            the required permissions to create an order.


            The error code in the response body appears as `40013` instead of `400`. This is because it is a 400
            response for the Orders resource, which has a numeric identifier of 13.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post-ordersRequestBadRequestError'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                orderId:
                  $ref: '#/components/schemas/orderId_REQUEST'
                poNumber:
                  $ref: '#/components/schemas/poNumber'
                isSaveOrderComment:
                  $ref: '#/components/schemas/isSaveOrderComment'
                  default: '0'
                extraFields:
                  $ref: '#/components/schemas/extraFields'
              required:
                - orderId
  /orders/images:
    get:
      operationId: get-orders-images
      summary: List Order Images
      description: >-
        Retrieves product image URLs based on the `orderIds[]` value in the parameters. You can return images for
        multiple orders by adding a separate `orderIds[]` parameter for each order.


        Equivalent Storefront GraphQL API Query: `orderImages`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - orders
      parameters:
        - name: orderIds[]
          in: query
          description: >-
            The BigCommerce order ID. This parameter does not accept the B2B Edition order ID returned in certain
            [Server to Server Orders endpoints](/developer/api-reference/rest/b2b/management/orders).


            This parameter is not an array, but you can filter for multiple order statuses by including additional
            `orderIds[]` parameters in the query. For example, `?orderIds[]=123&orderIds[]=124`.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_get-orders-images_Response_200'
  /orders/{orderId}/products:
    get:
      operationId: get-orders-orderId-products
      summary: List Order Products
      description: >-
        Retrieves basic product information for a specific B2B order.


        The request returns unique identifiers for a product, but it does not include more detailed information like
        pricing and physical dimensions. Use [Get Order Details](#get-order-details) to return full information on
        products from a particular order, or use [Get Ordered Product List](#get-ordered-product-list) to return
        information about products purchased by a Company user across multiple orders.


        Equivalent Storefront GraphQL API Query: `orderProducts`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - orders
      parameters:
        - name: orderId
          in: path
          description: >-
            The BigCommerce order ID. This parameter does not accept the B2B Edition order ID returned in certain
            [Server to Server Orders](/developer/api-reference/rest/b2b/management/orders) endpoints.
          required: true
          schema:
            type: integer
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_get-orders-orderId-products_Response_200'
        '404':
          description: >-
            Not Found


            This error occurs if the `orderId` value corresponds to an order that was not placed by the Company user, or
            if the order was placed while representing a subsidiary Company account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Get-orders-orderId-productsRequestNotFoundError'
  /orders/{orderId}/details:
    get:
      operationId: get-orders-orderId-details
      summary: Get Order Details
      description: >-
        Retrieves detailed information for a specific B2B order. This endpoint's response provides more granular
        information than the [Get All Orders](#get-all-orders) endpoint.


        If the queried order originated with a quote, the negotiated discount will either be represented as an order
        discount or reflected in the product prices, depending on the type of discount that was applied.


        The `price_tax` field in the `products` array contains the amount of tax based on the item's non-discounted
        price, while `total_tax` contains the final tax amount after factoring in any discounts.


        Equivalent Storefront GraphQL API Query: `order`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - orders
      parameters:
        - name: orderId
          in: path
          description: >-
            The BigCommerce order ID. This parameter does not accept the B2B Edition order ID returned in certain
            [Server to Server Orders](/developer/api-reference/rest/b2b/management/orders) endpoints.
          required: true
          schema:
            type: integer
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_get-orders-orderId-details_Response_200'
        '404':
          description: >-
            Not Found


            This error occurs if the `orderId` value corresponds to an order that was not placed by the Company user, or
            if the order was placed while representing a subsidiary Company account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Get-orders-orderId-detailsRequestNotFoundError'
  /ordered-products:
    get:
      operationId: get-ordered-products
      summary: List Ordered Products
      description: >-
        Retrieves information related to products that a Company user has purchased. The information returned by this
        endpoint is different from the detailed product information returned by [Get Order Details](#get-order-details).
        However, it does include unique information like how many times a product was ordered and when it was last
        ordered.


        The response includes all products purchased by the Company user, but you can filter for a subset of products by
        using parameters. Common use cases include:


        * Retrieving products purchased within a date range by using `beginDateAt` and `endDateAt`

        * Retrieving products ordered a specific number of times by using `minOrderedTimes` and `maxOrderedTimes`

        * Retrieving information on similarly-named products by entering a partial product name as a `q` value

        * Retrieving information on a specific product by using `productID`


        Equivalent Storefront GraphQL API Query: `orderedProducts`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - orders
      parameters:
        - name: offset
          in: query
          description: The number of results to skip before returning the first result. If left blank, this defaults to 0.
          required: false
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: Determines the number of records to return per page. If left blank, this defaults to 10.
          required: false
          schema:
            type: integer
            default: 10
        - name: beginDateAt
          in: query
          description: >-
            Enter a date in `%m/%d/%Y` format to retrieve all orders placed after that time. If the parameter is not
            included in the request, the resposne includes orders placed 30 days before the current date.
          required: false
          schema:
            type: string
            format: date-time
        - name: endDateAt
          in: query
          description: >-
            Enter a date in `%m/%d/%Y` format to retrieve all orders placed before that time. If the parameter is not
            included in the request, the current date is used.
          required: false
          schema:
            type: string
            format: date-time
        - name: minOrderedTimes
          in: query
          description: Enter a number to return products that have been ordered at least that many times by the Company user.
          required: false
          schema:
            type: number
            format: double
        - name: maxOrderedTimes
          in: query
          description: Enter a number to return products that have been ordered at least that many times by the Company user.
          required: false
          schema:
            type: number
            format: double
        - name: productID
          in: query
          description: The unique identifier for the product.
          required: false
          schema:
            type: number
            format: double
        - name: q
          in: query
          description: >-
            Enter order information to return partial and exact matches. Accepted information fields include order ID,
            order status name, Purchase Order (PO) number, and total order value including tax.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_get-ordered-products_Response_200'
  /rfq:
    get:
      operationId: get-rfq
      summary: List Quotes
      description: >-
        Retrieves basic information for all sales quotes assigned to the Company user. If the user's [quote
        permissions](/developer/api-reference/rest/b2b/storefront/request-for-quote#buyer-permissions) are set to the
        **Company** level, this will also return quotes assigned to all buyers in the Company account.


        The information in the response is equivalent to the details displayed in the quotes list, such as dates for
        creation and the last edit, or the status. Use [Get Quote Details](#get-rfq-quote_id) to return the information
        that is available while viewing a particular quote.


        Equivalent Storefront GraphQL Query: `quotes`.
      tags:
        - quotes
      parameters:
        - name: offset
          in: query
          description: The number of results to skip before returning the first result. If left blank, this defaults to `0`.
          required: false
          schema:
            type: integer
            default: '0'
        - name: limit
          in: query
          description: Determines the number of records to return per page. If left blank, this defaults to '10'.
          required: false
          schema:
            type: integer
            default: '10'
        - name: sortBy
          in: query
          description: >-
            Sorts results by last updated date (`updatedAt`), creation date (`createdAt`), expiration date
            (`expiredAt`), quote number (`quoteNumber`), quote title (`title`), sales rep name (`salesRep`), or quote
            status (`status`).
          required: false
          schema:
            $ref: '#/components/schemas/RfqGetParametersSortBy'
            default: updatedAt
        - name: orderBy
          in: query
          description: >-
            Establish a descending or ascending order of results. The order defaults to descending if the parameter is
            not included.
          required: false
          schema:
            $ref: '#/components/schemas/RfqGetParametersOrderBy'
            default: DESC
        - name: q
          in: query
          description: >-
            Enter quote information to return partial and exact matches. Accepted information fields include number,
            title, sales rep name, and Company user first and last name.
          required: false
          schema:
            type: string
        - name: quoteNumber
          in: query
          description: Enter a full or partial quote number to retrieve relevant quotes.
          required: false
          schema:
            type: string
        - name: company
          in: query
          description: >-
            Enter a Company name to retrieve relevant quotes. The response only retrieves quotes from a buyer's Company
            account by default.
          required: false
          schema:
            type: string
        - name: salesRep
          in: query
          description: The name of the sales rep assigned to the quote.
          required: false
          schema:
            type: string
        - name: status
          in: query
          description: >-
            The frontend status of the quote. Note that these are not the same as statuses observed in the B2B Edition
            control panel. See [Quote
            Statuses](/developer/api-reference/rest/b2b/storefront/request-for-quote#quote-statuses) for more
            information.
          required: false
          schema:
            $ref: '#/components/schemas/RfqGetParametersStatus'
        - name: quoteTitle
          in: query
          description: The external title given to the quote.
          required: false
          schema:
            type: string
        - name: createdBy
          in: query
          description: The name of the sales rep or buyer who created the quote.
          required: false
          schema:
            type: string
        - name: dateCreatedBeginAt
          in: query
          description: Enter a date to retrieve all quotes created after that time.
          required: false
          schema:
            type: string
        - name: dateCreatedEndAt
          in: query
          description: Enter a date to retrieve all quotes created before that time.
          required: false
          schema:
            type: string
        - name: dateUpdatedBeginAt
          in: query
          description: Enter a date to retrieve all quotes modified after that time.
          required: false
          schema:
            type: string
        - name: dateUpdatedEndAt
          in: query
          description: Enter a date to retrieve all quotes modified before that time.
          required: false
          schema:
            type: string
        - name: dateExpiredBeginAt
          in: query
          description: Enter a date to retrieve all quotes that expired after that time.
          required: false
          schema:
            type: string
        - name: dateExpiredEndAt
          in: query
          description: Enter a date to retrieve all quotes that expired before that time.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quotes_get-rfq_Response_200'
    post:
      operationId: post-rfq
      summary: Create Quote
      description: >-
        Creates a sales quote from the storefront and submits it to the B2B Edition control panel.


        Depending on your store's Quote settings configuration, this can be used anonymously to create a quote as a
        guest shopper, or authenticated with a B2C storefront customer or B2B Company user account. Quotes created with
        this endpoint share the same [minimum required
        fields](/developer/api-reference/rest/b2b/management/quotes#minimum-required-fields) as the Create a Quote
        endpoint in the Server to Server API.


        ### Draft Quotes


        The Buyer Portal allows buyers to save "draft" quotes" that they can edit further until they are ready to submit
        the quote to their sales representative. The built-Buyer Portal uses local storage, via the
        [Redux](https://redux.js.org/) library, to store a draft quote's details. This is different from quotes created
        within the B2B Edition control panel in Draft status, which is saved to the account itself and is visible to all
        backend users.
              
        The Create a Quote endpoint should only be used once a quote is ready to submit to a sales representative. Your
        application must save quote details in its own storage in order to support draft quotes.


        Equivalent Storefront GraphQL Mutation: `quoteCreate`.


        ### Pricing Field Considerations


        Note the following considerations related to pricing fields in the request:


        * Quotes created with this endpoint undergo a price validation check to prevent invalid prices. If the check
        fails, a `BigCommerce API Error` will be raised and logged, preventing quote creation.
            *  To create quotes with custom pricing, use [Create a Quote Form (Server-to-Server)](/developer/api-reference/rest/b2b/management/quotes#create-a-quote-form).
        * The `discount` field is present in the request body and the `productList` array; however, the value must be 0,
        since quote discounts are supplied by the sales rep.

        * The `offeredPrice` field on each item in the `productList` array must be provided, but it must equal the
        `basePrice` value for that product, since it is meant to reflect the quoted price which should not be different
        at this stage.

        * The `subtotal` and `grandTotal` fields must be equal to the sum of each product's `offeredPrice` multiplied by
        the `quantity`.
      tags:
        - quotes
      parameters:
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quotes_post-rfq_Response_200'
        '400':
          description: >-
            Bad Request


            This error occurs if the request body is missing any required fields. The error code is presented in the
            response as 40020.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post-rfqRequestBadRequestError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/quoteData_POST'
  /rfq/{quote_id}:
    get:
      operationId: get-rfq-quote_id
      summary: Get Quote Details
      description: >-
        Request retrieves the full details of a specific quote based on the provided `quote_id`.


        This endpoint provides more detailed information about a specific quote than [Get All Quotes](#get-all-quotes).
        This includes details on line items, shipping address fields, and even a history of messages sent by the buyer
        and their sales representative.


        Equivalent Storefront GraphQL API Query: `quote`.
      tags:
        - quotes
      parameters:
        - name: quote_id
          in: path
          description: The internal numeric ID of the sales quote.
          required: true
          schema:
            type: string
        - name: storeHash
          in: query
          description: The unique alphanumeric store hash for the BigCommerce store.
          required: true
          schema:
            type: string
        - name: date
          in: query
          description: The [Unix timestamp](https://www.unixtimestamp.com/) for when the sales quote was created.
          required: true
          schema:
            type: integer
        - name: uuid
          in: query
          description: >-
            The quote's secondary alphanumeric identifier. This field is only required if the quote has an existing
            value. Sales quotes created before May 3, 2026 do not have a `uuid` value by default.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quotes_get-rfq-quote_id_Response_200'
        '404':
          description: |-
            Not Found

            This error occurs if the `storeHash` entered in the query is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Get-rfq-quote_idRequestNotFoundError'
    put:
      operationId: put-rfq-quote_id
      summary: Send Quote Message
      description: >-
        Sends a message via the in-quote messaging system, from the perspective of the Company user.


        This PUT request cannot be used to edit other details of an existing quote. Once a quote has been submitted to
        the sales representative, buyers can no longer edit quote details like shipping address or line items.


        Equivalent Storefront GraphQL API Mutation: `quoteUpdate`.
      tags:
        - quotes
      parameters:
        - name: quote_id
          in: path
          description: The internal numeric ID of the sales quote.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quotes_put-rfq-quote_id_Response_200'
        '400':
          description: |-
            Bad Request

            This occurs if the values for `storeHash` and `quote_id` are missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Put-rfq-quote_idRequestBadRequestError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/quoteData_PUT'
  /rfq/{quote_id}/checkout:
    post:
      operationId: post-rfq-quote_id-checkout
      summary: Generate Cart and Checkout URL for Quote
      description: >-
        Generates a cart URL and a checkout URL for a specific quote based on the provided `quote_id`. Cart and checkout
        URLs can only be generated for quotes that are in the Open status.


        This endpoint will generate a checkout link for a quote even if it is configured to hide the checkout button on
        the Buyer Portal. You can use this to create an alternate checkout flow for your sales quotes.


        Equivalent Storefront GraphQL API Mutation: `quoteCheckout`.
      tags:
        - quotes
      parameters:
        - name: quote_id
          in: path
          description: The internal numeric ID of the sales quote.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quotes_post-rfq-quote_id-checkout_Response_200'
        '404':
          description: |-
            Not Found

            This error occurs if the quote associated with the `quote_id` is not in the Open status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responseNotFound'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                storeHash:
                  $ref: '#/components/schemas/storeHash'
  /rfq/{quote_id}/ordered:
    post:
      operationId: post-rfq-quote_id-ordered
      summary: Assign Quote to BigCommerce Order
      description: >-
        Associates an existing BigCommerce order with a specific quote based on the provided `quote_id`. In order to
        successfully assign a quote to an order, it must be in the Open status.


        This endpoint **does not** convert an unpurchased quote into a new BigCommerce order.


        The endpoint updates the existing order with the shipping and tax information provided in the request.


        Equivalent Storefront GraphQL API Mutation: `quoteOrdered`.
      tags:
        - quotes
      parameters:
        - name: quote_id
          in: path
          description: The internal numeric ID of the sales quote.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quotes_post-rfq-quote_id-ordered_Response_200'
        '400':
          description: >-
            Bad Request


            This error occurs if the `quote_id` is invalid, or if it corresponds to a sales quote that is already
            assigned to an order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post-rfq-quote_id-orderedRequestBadRequestError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/quoteData_ORDERED'
  /rfq/{quote_id}/pdf-export:
    post:
      operationId: post-rfq-quote_id-pdf-export
      summary: Export Quote PDF
      description: >-
        Generates a download link to a PDF copy of the specified quote. The PDF uses the default template configured in
        the store's Quote settings.


        You can opionally include the `currency` array in the request body to convert prices in the PDF to a specific
        currency. Currency details can be fetched with the [Get All Available
        Currencies](/developer/api-reference/rest/b2b/storefront/store-settings) endpoint.


        Equivalent Storefront GraphQL API Mutation: `quoteFrontendPdf`.
      tags:
        - quotes
      parameters:
        - name: quote_id
          in: path
          description: The internal numeric ID of the sales quote.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quotes_post-rfq-quote_id-pdf-export_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                storeHash:
                  $ref: '#/components/schemas/storeHash'
                currency:
                  $ref: '#/components/schemas/currency_RESPONSE'
  /rfq/configs:
    get:
      operationId: get-rfq-configs
      summary: Get Quote Configs
      description: >-
        Retrieves settings configurations related to storefront quotes from your store's General, Quotes, and Email
        settings, as well as built-in settings. This endpoint can be called without a Bearer token, as it returns
        information that can apply to guest shoppers.


        **Note:** The `storeHash` parameter must be included to return the store's configurations. If omitted, the
        response will be successful, but it will not contain any data.


        Equivalent Storefront GraphQL API Query: `quoteConfig`.


        ### Available Configs


        Quote configs appear in the response as key-value pairs. See the table to learn more about the setting that
        corresponds to each config key.


        | Config Key | Description |

        | --- | --- |

        | quote_reminder_notification | Indicates whether the Quote reminder template for buyers is enabled in the
        store's Email settings |

        | quote_customer | Indicates whether quotes are enabled in the Feature management area of the store's General
        settings |

        | quote_on_product_page | Indicates whether the product page Add to quote button is enabled in the store's
        Quotes settings |

        | quote_on_cart_page | Indicates whether the cart page Add to quote button is enabled in the store's Quotes
        settings |

        | quote_for_guest | Indicates whether quote requests are enabled for guest shoppers in the store's Quotes
        settings |

        | quote_for_individual_customer | Indicates whether quote requests are enabled for storefront customers in the
        store's Quotes settings |

        | quote_for_b2b | Indicates whether quote requests are enabled for Company users in the store's Quotes settings
        |

        | quote_sales_rep_visibility | Indicates whether Sales Staff users are restricted to viewing quotes from their
        assigned Companies. This is enabled by default, and cannot be disabled. |

        | quote_sales_rep_creation | Indicates whether the built-in Sales Rep system user role is authorized to create
        quotes in the B2B Edition control panel. This configuration cannot be disabled, but you can create a custom user
        role for Sales Staff without quote permissions. |

        | email_quote_for_merchant | Indicates whether the New quote email template for merchants is enabled in the
        store's Email settings |

        | quote_logo | The URL for the logo image in the store's General setings, which appears on quote emails and PDFs
        |

        | quote_cost_column | Indicates whether the store's Quotes settings are configured to display the product cost
        column in the line items table while viewing a quote in the B2B Edition control panel |

        | quote_margin_column | Indicates whether the store's Quotes settings are configured to display the cost margin
        column in the line items table while viewing a quote in the B2B Edition control panel |

        | customer_update_quote_message_email_sales_rep | Indicates whether Sales Staff users are notified via email
        when a buyer from an assigned Company has created a quote. This is configured during initial setup. |

        | sales_rep_update_quote_message_email_customer | Indicates whether buyers are notified via email when a Sales
        Staff user has created a quote for them. This is configured during initial setup. |

        | quote_send_customer_notes_to_order | Indicates whether the store's Quotes settings are configured to transfer
        customer-facing notes on the quote to the corresponding order by default |

        | quote_send_product_notes_to_order | Indicates whether the store's Quotes settings are configured to transfer
        line item-specific notes on the quote to the corresponding order by default |

        | quote_custom_shipping | Indicates whether custom shipping is enabled in the store's Quotes settings |

        | quote_default_pdf | The template used by default when buyers download a quote PDF |

        | defaultExpirationDate | The default number of days before a new quote expires |

        | defaultTermsAndConditions | The default terms and conditions configured in the store's Quotes settings |
      tags:
        - quotes
      parameters:
        - name: storeHash
          in: query
          description: The unique alphanumeric store hash for the BigCommerce store.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quotes_get-rfq-configs_Response_200'
  /rfq/emails:
    post:
      operationId: post-rfq-emails
      summary: Send Quote Email
      description: >-
        Sends a quote email to the specified email address.


        The email address in the `email` field must correspond with the buyer's email address on the quote. However, you
        can use the `ccTo` field to include additional recipients.


        Equivalent Storefront GraphQL API Query: `quoteEmail`.


        ### Quote Email Templates


        The request uses the `emailTemplate` field to format the quote contents with one of the pre-built quote email
        templates. You must enter the exact name of the template in the field.


        The following email templates can be used:


        * `Default with Checkout Button`

        * `Simple with Pictures`

        * `Waves with Pictures`

        * `Database with checkout button`

        * `Modern with checkout link`

        * `Modern without checkout link`


        The selected template applies to the quote PDF if `withAttach` is specified as `true`.
      tags:
        - quotes
      parameters:
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responseSuccess'
        '400':
          description: >-
            Bad Request


            This error occurs if the `email` field uses an email address that does not correspond to the buyer’s address
            on the quote.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post-rfq-emailsRequestBadRequestError'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                quoteId:
                  $ref: '#/components/schemas/quoteId'
                email:
                  $ref: '#/components/schemas/email'
                ccTo:
                  type: array
                  items:
                    type: string
                    format: email
                  description: The list of emails to CC.
                withAttach:
                  type: boolean
                  description: Indicates whether or not a quote PDF will be included with the email.
                emailTemplate:
                  $ref: '#/components/schemas/RfqEmailsPostRequestBodyContentApplicationJsonSchemaEmailTemplate'
                  description: The template used to format the quote email.
                emailLang:
                  $ref: '#/components/schemas/RfqEmailsPostRequestBodyContentApplicationJsonSchemaEmailLang'
                  description: The two-letter code for the language of the quote email and PDF, if included.
              required:
                - quoteId
                - email
  /rfq/store-info:
    get:
      operationId: get-rfq-store-info
      summary: Get Quote Store Info
      description: >-
        Retrieves basic information about the store, Company, sales rep, and extra field information. This is used in
        the storefront to provide basic information on a quote’s detail page, such as the quote logo and Sales Staff
        user details.


        The `companyId` and `salesRepId` parameters must be included in the query in order to return Company and sales
        rep information respectively. If omitted, the response still contains store and extra field information. 
      tags:
        - quotes
      parameters:
        - name: storeHash
          in: query
          description: The unique alphanumeric store hash for the BigCommerce store.
          required: false
          schema:
            type: string
        - name: companyId
          in: query
          description: The unique identifier for the Company account associated with the quote.
          required: false
          schema:
            type: string
        - name: salesRepId
          in: query
          description: The unique identifier for the Sales Staff user assigned to the quote.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quotes_get-rfq-store-info_Response_200'
  /sales-reps/{superAdminId}/companies:
    get:
      operationId: get-sales-reps-salesRepId-companies
      summary: Get Super Admin's Assigned Companies
      description: >-
        Returns the list of Companies that the Super Admin is assigned to.


        Equivalent Storefront GraphQL API Query: `superAdminCompanies`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - superAdmin
      parameters:
        - name: superAdminId
          in: path
          description: >-
            The unique numeric ID assigned to the Super Admin by B2B Edition. This ID does **not** match the BigCommerce
            customer account ID. To find the ID of a given Super Admin account, use the [Server-to-Server Super Admin
            API](/developer/api-reference/rest/b2b/management/super-admin).
          required: true
          schema:
            type: integer
        - name: offset
          in: query
          description: Number of results to skip before displaying the current page.
          required: false
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: Maximum number of results to display per page. Values over `250` will return only `250` results.
          required: false
          schema:
            type: integer
            default: 10
        - name: orderBy
          in: query
          description: >-
            Determines the Company field by which results will be sorted. If this is omitted, results are sorted by
            `companyId`.
          required: false
          schema:
            $ref: '#/components/schemas/SalesRepsSuperAdminIdCompaniesGetParametersOrderBy'
        - name: sortBy
          in: query
          description: Determines the sort order (ascending or descending) of the results.
          required: false
          schema:
            $ref: '#/components/schemas/SalesRepsSuperAdminIdCompaniesGetParametersSortBy'
            default: DESC
        - name: q
          in: query
          description: >-
            Search string for filtering results. If this parameter is provided, results will include entries with a
            partial match in `companyName` or `companyAdminEmail`.
          required: false
          schema:
            type: string
        - name: companyId
          in: query
          description: >-
            Search string for filtering results by `companyId`. Only returns data with an exact match in `companyId`.
            This ID does **not** match the ID shown in B2B Edition. To get a specific Company's ID, use the
            [Server-to-Server Company API](/developer/api-reference/rest/b2b/management/company/companies).
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Super Admin_get-sales-reps-salesRepId-companies_Response_200'
        '403':
          description: |-
            Unauthorized

            This response is returned if the Bearer Token included with the request does not match the `superAdminId`.
          content:
            application/json:
              schema:
                description: Any type
  /sales-reps/{superAdminId}/companies/masquerading:
    get:
      operationId: get-sales-reps-customerId-companies-masquerading
      summary: Get Super Admin's Current Masquerading Company
      description: >-
        Returns basic details for the Company the Super Admin is currently masquerading as.


        Equivalent Storefront GraphQL API Query: `superAdminMasquerading`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - superAdmin
      parameters:
        - name: superAdminId
          in: path
          description: >-
            The unique numeric ID assigned to the Super Admin by B2B Edition. This ID does **not** match the BigCommerce
            customer account ID. To find the ID of a given Super Admin account, use the [Server-to-Server Super Admin
            API](/developer/api-reference/rest/b2b/management/super-admin).
          required: true
          schema:
            type: integer
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Super Admin_get-sales-reps-customerId-companies-masquerading_Response_200'
        '403':
          description: |-
            Unauthorized

            This response is returned if the Bearer Token included with the request does not match the `superAdminId`.
          content:
            application/json:
              schema:
                description: Any type
  /sales-reps/{superAdminId}/companies/{companyId}/begin-masq:
    put:
      operationId: put-sales-reps-customerId-companies-companyId-begin-masq
      summary: Begin Super Admin Masquerade
      description: >-
        Updates the status of the Super Admin associated with `superAdminId` to masquerade as the Company associated
        with `companyId`.


        Equivalent Storefront GraphQL API Mutation: `superAdminBeginMasquerade`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - superAdmin
      parameters:
        - name: superAdminId
          in: path
          description: >-
            The unique numeric ID assigned to the Super Admin by B2B Edition. This ID does **not** match the BigCommerce
            customer account ID. To find the ID of a given Super Admin account, use the [Server-to-Server Super Admin
            API](/developer/api-reference/rest/b2b/management/super-admin).
          required: true
          schema:
            type: integer
        - name: companyId
          in: path
          description: >-
            The unique numeric ID for a Company to which the Super Admin is assigned. To find a Company ID, use the
            [Server-to-Server B2B Company API](/developer/api-reference/rest/b2b/management/company/companies). For
            stores using Dependent Company behavior, this **does not** match the ID found in B2B Edition.
          required: true
          schema:
            type: integer
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Super Admin_put-sales-reps-customerId-companies-companyId-begin-masq_Response_200'
  /sales-reps/{superAdminId}/companies/{companyId}/end-masq:
    put:
      operationId: put-sales-reps-customerId-companies-companyId-end-masq
      summary: End Super Admin Masquerade
      description: >-
        Updates the status of the Super Admin associated with `superAdminId`, ending their masquerade as the Company
        associated with `companyId`.


        Equivalent Storefront GraphQL API Mutation: `superAdminEndMasquerade`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - superAdmin
      parameters:
        - name: superAdminId
          in: path
          description: >-
            The unique numeric ID assigned to the Super Admin by B2B Edition. This ID does **not** match the BigCommerce
            customer account ID. To find the ID of a given Super Admin account, use the [Server-to-Server Super Admin
            API](/developer/api-reference/rest/b2b/management/super-admin).
          required: true
          schema:
            type: integer
        - name: companyId
          in: path
          description: >-
            The unique numeric ID for a Company to which the Super Admin is assigned. To find a Company ID, use the
            [Server-to-Server B2B Company API](/developer/api-reference/rest/b2b/management/company/companies). For
            stores using Dependent Company behavior, this **does not** match the ID found in B2B Edition.
          required: true
          schema:
            type: integer
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Super Admin_put-sales-reps-customerId-companies-companyId-end-masq_Response_200'
  /shoppinglists:
    get:
      operationId: get-shoppinglists
      summary: List Shopping Lists
      description: >-
        Get all shopping lists.

        Equivalent Storefront GraphQL API Query: `shoppingLists`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - shoppingList
      parameters:
        - name: offset
          in: query
          description: Pagination offset
          required: false
          schema:
            type: string
            default: '0'
        - name: limit
          in: query
          description: Pagination limit
          required: false
          schema:
            type: string
            default: '20'
        - name: isShowAll
          in: query
          description: If show all
          required: false
          schema:
            type: string
            default: '1'
        - name: orderBy
          in: query
          description: Order by
          required: false
          schema:
            type: string
            default: '-created_at'
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shopping List_get-shoppinglists_Response_200'
    post:
      operationId: post-shoppinglists
      summary: Create Shopping List
      description: >-
        Create a shopping list.

        Equivalent Storefront GraphQL API Mutation: `shoppingListsCreate`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - shoppingList
      parameters:
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shopping List_post-shoppinglists_Response_200'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                status:
                  $ref: '#/components/schemas/ShoppinglistsPostRequestBodyContentApplicationJsonSchemaStatus'
                  description: |-
                    0:   Approved
                    20:  Deleted
                    30:  Draft
                    40:  Ready for approval
              required:
                - name
                - description
                - status
    put:
      operationId: put-shoppinglists
      summary: Update Shopping List
      description: >-
        Update a shopping list.

        Equivalent Storefront GraphQL API Mutation: `shoppingListsUpdate`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - shoppingList
      parameters:
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shopping List_put-shoppinglists_Response_200'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Shopping list name
                description:
                  type: string
                  description: Description of this shopping list
                status:
                  type: number
                  format: double
                  description: |-
                    0:   Approved
                    20:  Deleted
                    30: Draft
                    40:  Ready for approval
                id:
                  type: string
                  description: Shopping list’s ID
              required:
                - name
                - description
                - status
                - id
  /shoppinglists/lists:
    get:
      operationId: get-shoppinglists-lists
      summary: Get Shopping List ID and Name
      description: |-
        > This endpoint is deprecated.

        Get all the shopping lists that contains both ID and name.
      tags:
        - shoppingList
      parameters:
        - name: status
          in: query
          description: 0:Approved  20:Deleted  30:Draft  40:Ready for approval
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shopping List_get-shoppinglists-lists_Response_200'
  /shoppinglists/items:
    post:
      operationId: post-shoppinglists-items
      summary: Add Shopping List Items
      description: >-
        Add items to an existed shopping list.

        Equivalent Storefront GraphQL API Mutation: `shoppingListsItemsCreate`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - shoppingList
      parameters:
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shopping List_post-shoppinglists-items_Response_200'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Shopping list ID
                items:
                  type: array
                  items:
                    $ref: '#/components/schemas/ShoppinglistsItemsPostRequestBodyContentApplicationJsonSchemaItemsItems'
              required:
                - id
                - items
    put:
      operationId: put-shoppinglists-items
      summary: Update Shopping List Items
      description: >-
        Update shopping lists items.

        Equivalent Storefront GraphQL API Mutation: `shoppingListsItemsUpdate`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - shoppingList
      parameters:
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shopping List_put-shoppinglists-items_Response_200'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              properties:
                shoppinglistId:
                  type: string
                  description: Shopping list ID field
                itemId:
                  type: string
                  description: Shopping list item ID field
                qty:
                  type: string
                  description: Quantity of product in shopping list
                optionList:
                  type: array
                  items:
                    $ref: '#/components/schemas/ShoppinglistsItemsPutRequestBodyContentApplicationJsonSchemaOptionListItems'
                  description: Product option of shopping list item
                variantId:
                  type: string
                  description: Product SKU ID
                sortOrder:
                  type: integer
                  description: The sort order for item
              required:
                - shoppinglistId
                - itemId
                - qty
                - optionList
                - variantId
  /shoppinglists/items-extension:
    get:
      operationId: get-shoppinglists-items-extension
      summary: List Shopping List Items Extension
      description: >-
        Get a shopping list detail information.

        Equivalent Storefront GraphQL API Query: `shoppingList`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - shoppingList
      parameters:
        - name: id
          in: query
          description: Shopping list ID
          required: false
          schema:
            type: string
        - name: offset
          in: query
          description: Pagination offset
          required: false
          schema:
            type: string
            default: '0'
        - name: limit
          in: query
          description: Pagination limit
          required: false
          schema:
            type: string
            default: '100'
        - name: sortBy
          in: query
          description: the field to sort by
          required: false
          schema:
            $ref: '#/components/schemas/ShoppinglistsItemsExtensionGetParametersSortBy'
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shopping List_get-shoppinglists-items-extension_Response_200'
  /shoppinglists/{shoppingListId}/items/{itemId}:
    delete:
      operationId: delete-shoppinglists-shoppingListId-items-itemId
      summary: Delete Shopping List Item
      description: >-
        Delete shopping list item using shoppingListId and itemId.

        Equivalent Storefront GraphQL API Mutation: `shoppingListsItemsDelete`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - shoppingList
      parameters:
        - name: shoppingListId
          in: path
          description: Shopping list ID
          required: true
          schema:
            type: string
        - name: itemId
          in: path
          description: Item id
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shopping List_delete-shoppinglists-shoppingListId-items-itemId_Response_200'
  /shoppinglists/{shoppingListId}:
    delete:
      operationId: delete-shoppinglists-shoppingListId
      summary: Delete Shopping List
      description: >-
        Delete a shopping list.

        Equivalent Storefront GraphQL API Mutation: `shoppingListsDelete`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - shoppingList
      parameters:
        - name: shoppingListId
          in: path
          description: Shopping list ID
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shopping List_delete-shoppinglists-shoppingListId_Response_200'
  /shoppinglists/duplicate:
    post:
      operationId: post-shoppinglists-duplicate
      summary: Duplicate Shopping List
      description: >-
        Duplicate a shopping list.

        Equivalent Storefront GraphQL API Mutation: `shoppingListsDuplicate`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - shoppingList
      parameters:
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shopping List_post-shoppinglists-duplicate_Response_200'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              properties:
                sampleShoppingListId:
                  type: number
                  format: double
                name:
                  type: string
                description:
                  type: string
              required:
                - sampleShoppingListId
                - name
                - description
  /stores/currencies:
    get:
      operationId: get-stores-currencies
      summary: List Available Currencies
      description: >-
        Returns a list of the currencies currently enabled on a BigCommerce store. If the `channelId` parameter is
        provided, the response will also include a list of currencies currently enabled for the associated storefront
        channel.


        **Note:** This endpoint is available with or without a Bearer Token. To use the endpoint without a token, the
        `storeHash` parameter is required.


        Equivalent Storefront GraphQL API Query: `currencies`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - storeSettings
      parameters:
        - name: channelId
          in: query
          description: >-
            The ID for a specific storefront channel. Including this parameter adds a list of channel-specific
            currencies to the response.
          required: false
          schema:
            type: string
        - name: storeHash
          in: query
          description: >-
            The unique store hash for the BigCommerce store.


            If a Bearer Token is provided with the request, the store's information is pulled using the token, and
            including the parameter will have no effect. If the Bearer Token is omitted this parameter is required to
            complete the request.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Store Settings_get-stores-currencies_Response_200'
        '400':
          description: |-
            Bad Request

            This response is returned if neither the Bearer Token nor the `storeHash` parameter is provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Get-stores-currenciesRequestBadRequestError'
  /stores/order-statuses:
    get:
      operationId: get-stores-order-statuses
      summary: List Store-Level Order Statuses
      description: >-
        Returns a list of all order statuses, including status codes and custom status names. For more information about
        order statuses generally, see  [Order
        Status](/developer/api-reference/rest/admin/management/orders/order-status) or [Order
        Statuses](https://support.bigcommerce.com/s/article/Order-Statuses).


        Equivalent Storefront GraphQL API Query: `orderStatuses`. For more information, see the [GraphQL
        Playground](https://api-b2b.bigcommerce.com/graphql/playground).
      tags:
        - storeSettings
      parameters:
        - name: Authorization
          in: header
          description: >-
            ### Authentication header

            | Header | Argument | Description |

            |:-------|:---------|:------------|

            |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the
            [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api)
            section[...]
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Store Settings_get-stores-order-statuses_Response_200'
servers:
  - url: https://api-b2b.bigcommerce.com/api
    description: https://api-b2b.bigcommerce.com/api
  - url: https://api-b2b.bigcommerce.com/api/v2
    description: https://api-b2b.bigcommerce.com/api
components:
  schemas:
    storeHash:
      type: string
      description: The unique store hash for the BigCommerce store.
      title: storeHash
    channelId:
      type: number
      format: double
      default: 1
      description: >-
        The storefront channel ID associated with the storefront login session. Use 1 for your store’s default
        storefront channel.
      title: channelId
    V2LoginPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        token:
          type: string
          description: >-
            The storefront authToken associated with the storefront login session, which can be used to validate further
            GraphQL requests.
      title: V2LoginPostResponsesContentApplicationJsonSchemaData
    Authentication_post-login_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/V2LoginPostResponsesContentApplicationJsonSchemaData'
        message:
          type: string
      title: Authentication_post-login_Response_200
    IoAuthCustomersPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
      title: IoAuthCustomersPostResponsesContentApplicationJsonSchemaData
    IoAuthCustomersPostResponsesContentApplicationJsonSchemaMeta:
      type: object
      properties:
        message:
          type: string
      title: IoAuthCustomersPostResponsesContentApplicationJsonSchemaMeta
    Authentication_post-auth-customer_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/IoAuthCustomersPostResponsesContentApplicationJsonSchemaData'
        meta:
          $ref: '#/components/schemas/IoAuthCustomersPostResponsesContentApplicationJsonSchemaMeta'
      title: Authentication_post-auth-customer_Response_200
    Post-auth-customerRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
        data:
          $ref: '#/components/schemas/IoAuthCustomersPostResponsesContentApplicationJsonSchemaData'
        meta:
          $ref: '#/components/schemas/IoAuthCustomersPostResponsesContentApplicationJsonSchemaMeta'
      title: Post-auth-customerRequestBadRequestError
    CatalogsVariantsGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        sku:
          type: string
          description: The Stock Keeping Unit for the product variant.
        variantId:
          type: integer
          description: Unique numeric identifier for the product variant assigned by BigCommerce.
      title: CatalogsVariantsGetResponsesContentApplicationJsonSchemaDataItems
    Catalog_get-catalogs-variants_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP status code indicating the result of the API operation.
        message:
          type: string
          default: Success
          description: Message describing the outcome of the request.
        data:
          type: array
          items:
            $ref: '#/components/schemas/CatalogsVariantsGetResponsesContentApplicationJsonSchemaDataItems'
          description: List of variant identifiers and their corresponding SKUs.
      title: Catalog_get-catalogs-variants_Response_200
    VariantOption:
      type: object
      properties:
        id:
          type: integer
          description: The unique option value ID as assigned by BigCommerce. Does **not** match the variant ID by default.
        label:
          type: string
          description: The display name for the specific option value.
        option_id:
          type: integer
          description: >-
            The unique option ID as assigned by BigCommerce. The option contains all the values associated with it. For
            example, a `Color` option might contain `red`, `green`, and `blue`.
        option_display_name:
          type: string
          description: The display name for the option.
      description: Option and corresponding value for a variant (e.g., color, size).
      title: VariantOption
    CatalogsQuickProductGetResponsesContentApplicationJsonSchemaDataItemsIsVisible:
      type: string
      enum:
        - '0'
        - '1'
      description: >-
        Indicates the variant's visibility status A value of `1` indicates the variant is visible, while `0` indicates
        it is hidden.
      title: CatalogsQuickProductGetResponsesContentApplicationJsonSchemaDataItemsIsVisible
    CatalogsQuickProductGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        id:
          type: integer
          description: The unique variant ID as assigned by BigCommerce.
        product_id:
          type: integer
          description: The unique product ID associated with the variant's parent product as assigned by BigCommerce.
        sku:
          type: string
          description: SKU (Stock Keeping Unit) for the variant. This field is unique in a given BigCommerce catalog.
        calculated_price:
          type: string
          title: float
          description: The calculated price of the variant including currency and sale adjustments.
        cost_price:
          type: string
          title: float
          description: The cost price of the variant.
        purchasing_disabled:
          type: boolean
          description: >-
            Indicates whether purchasing this variant is disabled. A value of `false` indicates that the product is
            purchasable on the storefront.
        image_url:
          type: string
          format: uri
          description: The URL to the image associated with the variant. This will usually be a BigCommerce CDN link.
        inventory_level:
          type: integer
          description: The current inventory level for the variant.
        option_values:
          type: array
          items:
            $ref: '#/components/schemas/VariantOption'
          description: The list of options and their values that determine the variant.
        variantSku:
          type: string
          description: The SKU of the variant (duplicated from `sku` for convenience).
        productId:
          type: string
          description: String representation of the product ID (duplicated from `product_id` for compatibility).
        variantId:
          type: string
          description: String representation of the variant ID (duplicated from `id` for compatibility).
        baseSku:
          type: string
          description: The base SKU from which the variant is derived. This is usually the SKU of the parent product, if it exists.
        productName:
          type: string
          description: The name of the product as displayed on product listing and detail pages.
        categories:
          type: array
          items:
            type: integer
          description: The list of category IDs to which the product is assigned.
        price:
          type: string
          title: float
          description: >-
            The default price of the variant (may be the same as `calculated_price` if sale price is unset and the
            default store currency is used).
        option:
          type: array
          items:
            $ref: '#/components/schemas/VariantOption'
          description: The list of options and their values that determine the variant. Duplicated from `option_values`.
        isVisible:
          $ref: '#/components/schemas/CatalogsQuickProductGetResponsesContentApplicationJsonSchemaDataItemsIsVisible'
          description: >-
            Indicates the variant's visibility status A value of `1` indicates the variant is visible, while `0`
            indicates it is hidden.
      title: CatalogsQuickProductGetResponsesContentApplicationJsonSchemaDataItems
    Catalog_get-catalogs-quickProduct_Response_200:
      type: object
      properties:
        code:
          type: integer
          description: HTTP status code indicating the result of the operation.
        message:
          type: string
          description: Message describing the result of the operation.
        data:
          type: array
          items:
            $ref: '#/components/schemas/CatalogsQuickProductGetResponsesContentApplicationJsonSchemaDataItems'
          description: List of product variant data objects.
      title: Catalog_get-catalogs-quickProduct_Response_200
    QuickVariantInfoItemIsStock:
      type: string
      enum:
        - '0'
        - '1'
      description: >-
        Indicates whether the variant is currently in stock. A value of `1` indicates the product in stock, otherwise
        `0`.
      title: QuickVariantInfoItemIsStock
    QuickVariantInfoItemPurchasingDisabled:
      type: string
      enum:
        - '0'
        - '1'
      description: >-
        Indicates whether purchasing this variant is disabled. A value of `0` indicates that the product is purchasable
        on the storefront.
      title: QuickVariantInfoItemPurchasingDisabled
    QuickVariantInfoItemIsVisible:
      type: string
      enum:
        - '1'
        - '0'
      description: >-
        Indicates the variant's visibility status A value of `1` indicates the variant is visible, while `0` indicates
        it is hidden.
      title: QuickVariantInfoItemIsVisible
    ModifierType:
      type: string
      enum:
        - swatch
        - radio_buttons
        - rectangles
        - dropdown
        - product_list_with_images
        - product_list
        - text
        - checkbox
        - numbers_only_text
        - date
        - multi_line_text
        - file
      description: >-
        The modifier's type. This value determines how the modifier behaves on the storefront as well as what datatypes
        are allowed. For more information see the [Product
        Modifiers](/developer/api-reference/rest/admin/catalog/product-modifiers) API documentation.
      title: ModifierType
    ModifierConfig:
      type: object
      properties: {}
      description: >-
        The configuration of the specific modifier. Different modifier `type` values require different structures for
        this object. For more information, see the [Product
        Modifiers](/developer/api-reference/rest/admin/catalog/product-modifiers) API documentation.
      title: ModifierConfig
    ModifierOptionValuesItems:
      type: object
      properties: {}
      title: ModifierOptionValuesItems
    Modifier:
      type: object
      properties:
        id:
          type: integer
          description: The unique modifier ID assigned by BigCommerce.
        productId:
          type: integer
          description: The unique ID for the product the modifier belongs to.
        name:
          type: string
          description: The internal modifier name. This is **not** visible on the storefront by default.
        displayName:
          type: string
          description: The modifier's display name as shown on the storefront.
        type:
          $ref: '#/components/schemas/ModifierType'
          description: >-
            The modifier's type. This value determines how the modifier behaves on the storefront as well as what
            datatypes are allowed. For more information see the [Product
            Modifiers](/developer/api-reference/rest/admin/catalog/product-modifiers) API documentation.
        required:
          type: boolean
          description: Indicates whether the modifier is required when adding the variant to cart.
        sortOrder:
          type: integer
          description: Indicates the position of the modifier. Lower values are placed earlier in modifier lists.
        config:
          $ref: '#/components/schemas/ModifierConfig'
          description: >-
            The configuration of the specific modifier. Different modifier `type` values require different structures
            for this object. For more information, see the [Product
            Modifiers](/developer/api-reference/rest/admin/catalog/product-modifiers) API documentation.
        optionValues:
          type: array
          items:
            $ref: '#/components/schemas/ModifierOptionValuesItems'
          description: >-
            An array of modifier values, as created within BigCommerce. Different modifier `type` values use different
            structures for this array. For more information, see the [Product
            Modifiers](/developer/api-reference/rest/admin/catalog/product-modifiers) API documentation.
      description: Modifiers associated with a product variant.
      title: Modifier
    QuickVariantInfoItem:
      type: object
      properties:
        isStock:
          $ref: '#/components/schemas/QuickVariantInfoItemIsStock'
          description: >-
            Indicates whether the variant is currently in stock. A value of `1` indicates the product in stock,
            otherwise `0`.
        stock:
          type: integer
          description: Current inventory of the variant. If this value returns `0`, so will the `isStock` field.
        variantSku:
          type: string
          description: SKU (Stock Keeping Unit) for the variant. This field is unique in a given BigCommerce catalog.
        productId:
          type: string
          description: String representation of the product ID for the parent product of the variant.
        calculatedPrice:
          type: number
          format: double
          description: The calculated price of the variant including currency and sale adjustments.
        imageUrl:
          type: string
          description: The URL for the image associated with the variant. May return an empty string.
        variantId:
          type: integer
          description: The unique variant ID as assigned by BigCommerce.
        baseSku:
          type: string
          description: The base SKU from which the variant is derived. This is usually the SKU of the parent product, if it exists.
        productName:
          type: string
          description: The name of the product as displayed on product listing and detail pages.
        categories:
          type: array
          items:
            type: integer
          description: The list of category IDs to which the product is assigned.
        option:
          type: array
          items:
            $ref: '#/components/schemas/VariantOption'
          description: The list of options and their values that determine the variant.
        minQuantity:
          type: integer
          description: The minimum purchase quantity for the variant, as assigned in BigCommerce.
        maxQuantity:
          type: integer
          description: The maximum purchase quantity for the variant, as assigned in BigCommerce.
        purchasingDisabled:
          $ref: '#/components/schemas/QuickVariantInfoItemPurchasingDisabled'
          description: >-
            Indicates whether purchasing this variant is disabled. A value of `0` indicates that the product is
            purchasable on the storefront.
        isVisible:
          $ref: '#/components/schemas/QuickVariantInfoItemIsVisible'
          description: >-
            Indicates the variant's visibility status A value of `1` indicates the variant is visible, while `0`
            indicates it is hidden.
        modifiers:
          type: array
          items:
            $ref: '#/components/schemas/Modifier'
          description: List of product modifiers available to the variant.
      description: Detailed information about a specific variant.
      title: QuickVariantInfoItem
    QuickVariantInfoResponse:
      type: object
      properties:
        code:
          type: integer
          description: HTTP status code of the response.
        message:
          type: string
          description: Status message.
        data:
          type: array
          items:
            $ref: '#/components/schemas/QuickVariantInfoItem'
          description: List of product variant info objects.
      title: QuickVariantInfoResponse
    stateObject:
      type: object
      properties:
        stateName:
          type: string
        stateCode:
          type: string
      description: State of the address as an object with both the name and the two-character code.
      title: stateObject
    countryWithState:
      type: object
      properties:
        id:
          type: number
          format: double
        countryName:
          type: string
        countryCode:
          type: string
        states:
          type: array
          items:
            $ref: '#/components/schemas/stateObject'
      description: Country of the address as an object with both the name and the two-character code.
      title: countryWithState
    CompaniesAddressesCountriesGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/countryWithState'
      title: CompaniesAddressesCountriesGetResponsesContentApplicationJsonSchemaData
    Addresses_get-companies-addresses-countries_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/CompaniesAddressesCountriesGetResponsesContentApplicationJsonSchemaData'
      title: Addresses_get-companies-addresses-countries_Response_200
    CompaniesAddressesPermissionGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        isAllow:
          type: string
          description: >-
            Indicates whether users are allowed to modify addresses from the storefront. A value of `1` indicates
            storefront address management is allowed. A value of `0` indicates it is not.
        isEnabled:
          type: string
          description: >-
            Indicates whether storefront address management is enabled. A value of `1` indicates the feature is enabled.
            A value of `0` indicates the feature is disabled and the setting of `isAllow` will have no effect.
      title: CompaniesAddressesPermissionGetResponsesContentApplicationJsonSchemaData
    Addresses_get-companies-addresses-permission_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/CompaniesAddressesPermissionGetResponsesContentApplicationJsonSchemaData'
      title: Addresses_get-companies-addresses-permission_Response_200
    addressIdInt:
      type: number
      format: double
      description: The unique ID of the address.
      title: addressIdInt
    addressLabel:
      type: string
      description: The label used on the storefront to identify the address.
      title: addressLabel
    addressFirstName:
      type: string
      description: The first name of the address.
      title: addressFirstName
    addressPhone:
      type: string
      description: The phone number associated with the address.
      title: addressPhone
    companyCity:
      type: string
      description: City of the address.
      title: companyCity
    zipCode:
      type: string
      description: Zip or Postal Code of the address.
      title: zipCode
    countryObject:
      type: object
      properties:
        countryName:
          type: string
        countryCode:
          type: string
      description: Country of the address as an object with both the name and the two-character code.
      title: countryObject
    CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressIdExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
          description: Field name that config in you store
        fieldValue:
          type: string
          description: Value of the extra field.
      required:
        - fieldName
        - fieldValue
      title: CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressIdExtraFieldsItems
    CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressId:
      type: object
      properties:
        addressId:
          $ref: '#/components/schemas/addressIdInt'
        lastName:
          type: string
          description: The last name of the address.
        isShipping:
          type: number
          format: double
          description: Indicates whether the address can be used as a shipping address.
        isBilling:
          type: number
          format: double
          description: Indicates whether the address can be used as a billing address.
        label:
          $ref: '#/components/schemas/addressLabel'
        firstName:
          $ref: '#/components/schemas/addressFirstName'
        phoneNumber:
          $ref: '#/components/schemas/addressPhone'
        addressLine1:
          type: string
          description: The first line of the address
        addressLine2:
          type: string
          description: The second line of the address
        city:
          $ref: '#/components/schemas/companyCity'
        zipCode:
          $ref: '#/components/schemas/zipCode'
        state:
          $ref: '#/components/schemas/stateObject'
        country:
          $ref: '#/components/schemas/countryObject'
        extraFields:
          type: array
          items:
            $ref: >-
              #/components/schemas/CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressIdExtraFieldsItems
      description: Extra Field Values
      title: CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressId
    CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddresses:
      type: object
      properties:
        addressId:
          $ref: >-
            #/components/schemas/CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressId
          description: Extra Field Values
      description: Addresses are returned as member objects within this object using the `addressId` as the member key.
      title: CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddresses
    CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        addresses:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddresses'
          description: Addresses are returned as member objects within this object using the `addressId` as the member key.
        defaultShippingId:
          type: string
          description: The ID of the default shipping address for the Company account.
        defaultBillingId:
          type: string
          description: The ID of the default billing address for the Company account.
        canEnterNewAddress:
          type: boolean
          description: Indicates whether users can enter addresses.
      title: CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaData
    Addresses_get-companies-companyId-addresses_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaData'
      title: Addresses_get-companies-companyId-addresses_Response_200
    isShipping:
      type: string
      description: Indicates whether the address can be used as a shipping address.
      title: isShipping
    isBilling:
      type: string
      description: Indicates whether the address can be used as a billing address.
      title: isBilling
    isDefaultShipping:
      type: string
      description: Indicates whether the address is the default shipping address for the Company account.
      title: isDefaultShipping
    isDefaultBilling:
      type: string
      description: Indicates whether the address is the default billing address for the Company account.
      title: isDefaultBilling
    CompaniesCompanyIdAddressesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
          description: Field name that config in you store
        fieldValue:
          type: string
          description: Value of the extra field.
      required:
        - fieldName
        - fieldValue
      title: CompaniesCompanyIdAddressesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems
    CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Details of the validation failure.
      title: CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaData
    Addresses_post-companies-companyId-addresses_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaData'
      title: Addresses_post-companies-companyId-addresses_Response_200
    Post-companies-companyId-addressesRequestBadRequestError:
      type: object
      properties:
        code:
          type: integer
          description: The application-level error code for the response.
        message:
          type: string
          description: A message describing the error.
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Post-companies-companyId-addressesRequestBadRequestError
    companyId:
      type: string
      description: Unique numeric ID of the Company account.
      title: companyId
    companyName:
      type: string
      description: The name of the Company associated with the order's buyer.
      title: companyName
    addressLastName:
      type: string
      description: The last name of the address.
      title: addressLastName
    companyAddressResponse:
      type: object
      properties:
        companyId:
          $ref: '#/components/schemas/companyId'
        companyName:
          $ref: '#/components/schemas/companyName'
        companyAddress:
          type: string
          description: The local address information for the address.
        companyCity:
          $ref: '#/components/schemas/companyCity'
        companyState:
          type: string
          description: The name of the state, if applicable, for the address.
        companyStateCode:
          type: string
          description: The state code, if applicable, for the address
        companyZipCode:
          $ref: '#/components/schemas/zipCode'
        companyCountry:
          type: string
          description: The name of the country for the address.
        companyCountryCode:
          type: string
          description: The country code for the address
        firstName:
          $ref: '#/components/schemas/addressFirstName'
        lastName:
          $ref: '#/components/schemas/addressLastName'
        phoneNumber:
          $ref: '#/components/schemas/addressPhone'
        label:
          $ref: '#/components/schemas/addressLabel'
      title: companyAddressResponse
    responsePagination:
      type: object
      properties:
        totalCount:
          type: number
          format: double
          description: The total number of items matching the query.
        offset:
          type: number
          format: double
          description: The starting offset for the current page of the response.
        limit:
          type: number
          format: double
          description: The maximum number of items allowed per page of the response.
      title: responsePagination
    CompaniesCompanyIdAddressesSearchesGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        addressBookStatus:
          type: string
        defaultAddress:
          $ref: '#/components/schemas/companyAddressResponse'
        list:
          type: array
          items:
            $ref: '#/components/schemas/companyAddressResponse'
        pagination:
          $ref: '#/components/schemas/responsePagination'
      title: CompaniesCompanyIdAddressesSearchesGetResponsesContentApplicationJsonSchemaData
    Addresses_get-companies-companyId-addresses-searches_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesSearchesGetResponsesContentApplicationJsonSchemaData'
      title: Addresses_get-companies-companyId-addresses-searches_Response_200
    stateString:
      type: string
      description: State of the address.
      title: stateString
    countryString:
      type: string
      description: Country of the address.
      title: countryString
    CompaniesCompanyIdAddressesSearchesPostRequestBodyContentApplicationJsonSchemaFiltersAddressType:
      type: object
      properties:
        isBilling:
          $ref: '#/components/schemas/isBilling'
        isShipping:
          $ref: '#/components/schemas/isShipping'
      title: CompaniesCompanyIdAddressesSearchesPostRequestBodyContentApplicationJsonSchemaFiltersAddressType
    CompaniesCompanyIdAddressesSearchesPostRequestBodyContentApplicationJsonSchemaFilters:
      type: object
      properties:
        firstName:
          $ref: '#/components/schemas/addressFirstName'
        lastName:
          $ref: '#/components/schemas/addressLastName'
        city:
          $ref: '#/components/schemas/companyCity'
        phoneNumber:
          $ref: '#/components/schemas/addressPhone'
        zipCode:
          $ref: '#/components/schemas/zipCode'
        label:
          $ref: '#/components/schemas/addressLabel'
        address:
          type: string
        state:
          $ref: '#/components/schemas/stateString'
        country:
          $ref: '#/components/schemas/countryString'
        addressType:
          $ref: >-
            #/components/schemas/CompaniesCompanyIdAddressesSearchesPostRequestBodyContentApplicationJsonSchemaFiltersAddressType
      title: CompaniesCompanyIdAddressesSearchesPostRequestBodyContentApplicationJsonSchemaFilters
    addressId:
      type: string
      description: The unique ID of the address.
      title: addressId
    CompaniesCompanyIdAddressesSearchesPostResponsesContentApplicationJsonSchemaDataListItemsExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
          description: Field name that config in you store
        fieldValue:
          type: string
          description: Value of the extra field.
      required:
        - fieldName
        - fieldValue
      title: CompaniesCompanyIdAddressesSearchesPostResponsesContentApplicationJsonSchemaDataListItemsExtraFieldsItems
    CompaniesCompanyIdAddressesSearchesPostResponsesContentApplicationJsonSchemaDataListItems:
      type: object
      properties:
        addressId:
          $ref: '#/components/schemas/addressId'
        isDefaultShipping:
          $ref: '#/components/schemas/isDefaultShipping'
        isDefaultBilling:
          $ref: '#/components/schemas/isDefaultBilling'
        firstName:
          $ref: '#/components/schemas/addressFirstName'
        lastName:
          $ref: '#/components/schemas/addressLastName'
        city:
          $ref: '#/components/schemas/companyCity'
        phoneNumber:
          $ref: '#/components/schemas/addressPhone'
        zipCode:
          $ref: '#/components/schemas/zipCode'
        label:
          $ref: '#/components/schemas/addressLabel'
        isShipping:
          $ref: '#/components/schemas/isShipping'
        isBilling:
          $ref: '#/components/schemas/isBilling'
        addressLine1:
          type: string
          description: The first line of the address
        addressLine2:
          type: string
          description: The second line of the address
        state:
          $ref: '#/components/schemas/stateObject'
        country:
          $ref: '#/components/schemas/countryObject'
        extraFields:
          type: array
          items:
            $ref: >-
              #/components/schemas/CompaniesCompanyIdAddressesSearchesPostResponsesContentApplicationJsonSchemaDataListItemsExtraFieldsItems
      description: Extra Field Values
      title: CompaniesCompanyIdAddressesSearchesPostResponsesContentApplicationJsonSchemaDataListItems
    CompaniesCompanyIdAddressesSearchesPostResponsesContentApplicationJsonSchemaDataDefaultAddressIds:
      type: object
      properties:
        shippingAddressId:
          type: string
        billingAddressId:
          type: string
      title: CompaniesCompanyIdAddressesSearchesPostResponsesContentApplicationJsonSchemaDataDefaultAddressIds
    CompaniesCompanyIdAddressesSearchesPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: >-
              #/components/schemas/CompaniesCompanyIdAddressesSearchesPostResponsesContentApplicationJsonSchemaDataListItems
        defaultAddressIds:
          $ref: >-
            #/components/schemas/CompaniesCompanyIdAddressesSearchesPostResponsesContentApplicationJsonSchemaDataDefaultAddressIds
        pagination:
          $ref: '#/components/schemas/responsePagination'
      title: CompaniesCompanyIdAddressesSearchesPostResponsesContentApplicationJsonSchemaData
    Addresses_post-companies-companyId-addresses-searches_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesSearchesPostResponsesContentApplicationJsonSchemaData'
      title: Addresses_post-companies-companyId-addresses-searches_Response_200
    CompaniesCompanyIdAddressesAddressIdGetResponsesContentApplicationJsonSchemaDataExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
          description: Field name that config in you store
        fieldValue:
          type: string
          description: Value of the extra field.
      required:
        - fieldName
        - fieldValue
      title: CompaniesCompanyIdAddressesAddressIdGetResponsesContentApplicationJsonSchemaDataExtraFieldsItems
    CompaniesCompanyIdAddressesAddressIdGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        firstName:
          $ref: '#/components/schemas/addressFirstName'
        isShipping:
          $ref: '#/components/schemas/isShipping'
        isBilling:
          $ref: '#/components/schemas/isBilling'
        phoneNumber:
          $ref: '#/components/schemas/addressPhone'
        addressLine1:
          type: string
          description: The first line of the address
        addressLine2:
          type: string
          description: The second line of the address
        city:
          $ref: '#/components/schemas/companyCity'
        zipCode:
          $ref: '#/components/schemas/zipCode'
        state:
          $ref: '#/components/schemas/stateObject'
        country:
          $ref: '#/components/schemas/countryObject'
        addressId:
          $ref: '#/components/schemas/addressId'
        lastName:
          $ref: '#/components/schemas/addressLastName'
        isDefaultShipping:
          $ref: '#/components/schemas/isDefaultShipping'
        isDefaultBilling:
          $ref: '#/components/schemas/isDefaultBilling'
        label:
          $ref: '#/components/schemas/addressLabel'
        extraFields:
          type: array
          items:
            $ref: >-
              #/components/schemas/CompaniesCompanyIdAddressesAddressIdGetResponsesContentApplicationJsonSchemaDataExtraFieldsItems
      description: Extra Field Values
      title: CompaniesCompanyIdAddressesAddressIdGetResponsesContentApplicationJsonSchemaData
    Addresses_get-companies-companyId-addresses-addressId_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesAddressIdGetResponsesContentApplicationJsonSchemaData'
          description: Extra Field Values
      title: Addresses_get-companies-companyId-addresses-addressId_Response_200
    CompaniesCompanyIdAddressesAddressIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
          description: Field name that config in you store
        fieldValue:
          type: string
          description: Value of the extra field.
      required:
        - fieldName
        - fieldValue
      title: CompaniesCompanyIdAddressesAddressIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems
    CompaniesCompanyIdAddressesAddressIdPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Details of the validation failure.
      title: CompaniesCompanyIdAddressesAddressIdPutResponsesContentApplicationJsonSchemaData
    Addresses_put-companies-companyId-addresses-addressId_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesAddressIdPutResponsesContentApplicationJsonSchemaData'
      title: Addresses_put-companies-companyId-addresses-addressId_Response_200
    Put-companies-companyId-addresses-addressIdRequestBadRequestError:
      type: object
      properties:
        code:
          type: integer
          description: The application-level error code for the response.
        message:
          type: string
          description: A message describing the error.
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesAddressIdPutResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Put-companies-companyId-addresses-addressIdRequestBadRequestError
    CompaniesCompanyIdAddressesAddressIdActivationPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        addressId:
          $ref: '#/components/schemas/addressId'
      title: CompaniesCompanyIdAddressesAddressIdActivationPutResponsesContentApplicationJsonSchemaData
    Addresses_put-companies-companyId-addresses-addressId-activation_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: >-
            #/components/schemas/CompaniesCompanyIdAddressesAddressIdActivationPutResponsesContentApplicationJsonSchemaData
      title: Addresses_put-companies-companyId-addresses-addressId-activation_Response_200
    CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaDataShippingExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
          description: Field name that config in you store
        fieldValue:
          type: string
          description: Value of the extra field.
      required:
        - fieldName
        - fieldValue
      title: CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaDataShippingExtraFieldsItems
    CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaDataShipping:
      type: object
      properties:
        addressId:
          $ref: '#/components/schemas/addressId'
        firstName:
          $ref: '#/components/schemas/addressFirstName'
        lastName:
          $ref: '#/components/schemas/addressLastName'
        phoneNumber:
          $ref: '#/components/schemas/addressPhone'
        label:
          $ref: '#/components/schemas/addressLabel'
        addressLine1:
          type: string
          description: The first line of the address
        addressLine2:
          type: string
          description: The second line of the address
        city:
          $ref: '#/components/schemas/companyCity'
        zipCode:
          $ref: '#/components/schemas/zipCode'
        state:
          $ref: '#/components/schemas/stateObject'
        country:
          $ref: '#/components/schemas/countryObject'
        extraFields:
          type: array
          items:
            $ref: >-
              #/components/schemas/CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaDataShippingExtraFieldsItems
      description: Extra Field Values
      title: CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaDataShipping
    CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaDataBillingExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
          description: Field name that config in you store
        fieldValue:
          type: string
          description: Value of the extra field.
      required:
        - fieldName
        - fieldValue
      title: CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaDataBillingExtraFieldsItems
    CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaDataBilling:
      type: object
      properties:
        addressId:
          $ref: '#/components/schemas/addressId'
        firstName:
          $ref: '#/components/schemas/addressFirstName'
        lastName:
          $ref: '#/components/schemas/addressLastName'
        phoneNumber:
          $ref: '#/components/schemas/addressPhone'
        label:
          $ref: '#/components/schemas/addressLabel'
        addressLine1:
          type: string
          description: The first line of the address
        addressLine2:
          type: string
          description: The second line of the address
        city:
          $ref: '#/components/schemas/companyCity'
        zipCode:
          $ref: '#/components/schemas/zipCode'
        state:
          $ref: '#/components/schemas/stateObject'
        country:
          $ref: '#/components/schemas/countryObject'
        extraFields:
          type: array
          items:
            $ref: >-
              #/components/schemas/CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaDataBillingExtraFieldsItems
      description: Extra Field Values
      title: CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaDataBilling
    CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        shipping:
          $ref: '#/components/schemas/CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaDataShipping'
          description: Extra Field Values
        billing:
          $ref: '#/components/schemas/CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaDataBilling'
          description: Extra Field Values
      title: CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaData
    Addresses_get-companies-companyId-default-addresses_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdDefaultAddressesGetResponsesContentApplicationJsonSchemaData'
      title: Addresses_get-companies-companyId-default-addresses_Response_200
    companyPhone:
      type: string
      description: The primary phone number for the Company account.
      title: companyPhone
    customerEmail:
      type: string
      format: email
      description: >-
        The email address of the BigCommerce customer account for the Company account administrator. Must match the
        email on the customer account identified by `customerId`.
      title: customerEmail
    email_BASE:
      type: string
      format: email
      title: email_BASE
    FrontendCompaniesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
          description: The name of the extra field.
        fieldValue:
          type: string
          description: The value of the extra field as a string, dependent on the `fieldType`.
      title: FrontendCompaniesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems
    FrontendCompaniesPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      description: Response data.
      title: FrontendCompaniesPostResponsesContentApplicationJsonSchemaData
    Companies_createcompany(frontend)_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          default: 200
        message:
          type: string
        data:
          $ref: '#/components/schemas/FrontendCompaniesPostResponsesContentApplicationJsonSchemaData'
      title: Companies_createcompany(frontend)_Response_200
    Createcompany(frontend)RequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: The application-level error code for the response.
        data:
          $ref: '#/components/schemas/FrontendCompaniesPostResponsesContentApplicationJsonSchemaData'
          description: Response data.
        message:
          type: string
          description: A message describing the error.
      title: Createcompany(frontend)RequestBadRequestError
    ExtraFieldsFullItemsDataType:
      type: string
      enum:
        - '0'
        - '1'
        - '2'
        - '3'
      description: |-
        The type of data that can be added as the extra field’s value.

        | Value | Type |
        | --- | ---|
        | `0` | text |
        | `1` | multi-line text |
        | `2` | numbers |
        | `3` | dropdown |
      title: ExtraFieldsFullItemsDataType
    ExtraFieldsFullItemsIsRequired:
      type: string
      enum:
        - '0'
        - '1'
      description: |-
        Indicates whether or not the extra field must be filled out in order to create a Company account.

        `0`=not required, `1`=required
      title: ExtraFieldsFullItemsIsRequired
    ExtraFieldsFullItems:
      type: object
      properties:
        fieldName:
          type: string
          description: The name of the Company extra field.
        labelName:
          type: string
          description: The display name of the Company extra field as visible to the customer.
        dataType:
          $ref: '#/components/schemas/ExtraFieldsFullItemsDataType'
          description: |-
            The type of data that can be added as the extra field’s value.

            | Value | Type |
            | --- | ---|
            | `0` | text |
            | `1` | multi-line text |
            | `2` | numbers |
            | `3` | dropdown |
        isRequired:
          $ref: '#/components/schemas/ExtraFieldsFullItemsIsRequired'
          description: |-
            Indicates whether or not the extra field must be filled out in order to create a Company account.

            `0`=not required, `1`=required
      title: ExtraFieldsFullItems
    extraFields_FULL:
      type: array
      items:
        $ref: '#/components/schemas/ExtraFieldsFullItems'
      title: extraFields_FULL
    Companies_get-companies-extra_fields-storefront_Response_200:
      type: object
      properties:
        message:
          type: string
        data:
          $ref: '#/components/schemas/extraFields_FULL'
        code:
          type: number
          format: double
          default: 200
      title: Companies_get-companies-extra_fields-storefront_Response_200
    CustomersUserIdCompaniesGetResponsesContentApplicationJsonSchemaDataCopanyStatus:
      type: string
      enum:
        - '0'
        - '1'
        - '2'
        - '3'
      description: >-
        The Company’s activity status. See [Company Status
        Codes](/developer/api-reference/rest/b2b/management/company/companies#company-status-codes) to learn about their
        corresponding statuses.
      title: CustomersUserIdCompaniesGetResponsesContentApplicationJsonSchemaDataCopanyStatus
    catalogId:
      type: string
      description: The ID of the price list assigned to the Company account.
      title: catalogId
    ExtraFieldsExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
          description: The name of the order extra field.
        fieldValue:
          type: string
          description: The value of the order extra field.
      title: ExtraFieldsExtraFieldsItems
    extraFields:
      type: object
      properties:
        extraFields:
          type: array
          items:
            $ref: '#/components/schemas/ExtraFieldsExtraFieldsItems'
          description: Contains extra field information associated with the order.
      title: extraFields
    CustomersUserIdCompaniesGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        companyId:
          $ref: '#/components/schemas/companyId'
        companyName:
          $ref: '#/components/schemas/companyName'
        bcGroupName:
          type: string
          description: >-
            The internal name of the BigCommerce customer group assigned to the Company account. This field is
            read-only.
        copanyStatus:
          $ref: '#/components/schemas/CustomersUserIdCompaniesGetResponsesContentApplicationJsonSchemaDataCopanyStatus'
          description: >-
            The Company’s activity status. See [Company Status
            Codes](/developer/api-reference/rest/b2b/management/company/companies#company-status-codes) to learn about
            their corresponding statuses.
        description:
          type: string
          description: The name of the business associated with the Company account.
        catalogId:
          $ref: '#/components/schemas/catalogId'
        extraFields:
          $ref: '#/components/schemas/extraFields'
        addressLine1:
          type: string
          description: The first line of the address
        addressLine2:
          type: string
          description: The second line of the address
        city:
          $ref: '#/components/schemas/companyCity'
        zipCode:
          $ref: '#/components/schemas/zipCode'
        state:
          $ref: '#/components/schemas/stateString'
        country:
          $ref: '#/components/schemas/countryString'
      title: CustomersUserIdCompaniesGetResponsesContentApplicationJsonSchemaData
    Companies_getcompanybyuserid_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/CustomersUserIdCompaniesGetResponsesContentApplicationJsonSchemaData'
      title: Companies_getcompanybyuserid_Response_200
    CompaniesCompanyIdUsersGetParametersRole:
      type: string
      enum:
        - '0'
        - '1'
        - '2'
      title: CompaniesCompanyIdUsersGetParametersRole
    userFirstName:
      type: string
      description: The user's first name.
      title: userFirstName
    userLastName:
      type: string
      description: The user's last name.
      title: userLastName
    userEmail:
      type: string
      format: email
      description: The email address associated with the user's account.
      title: userEmail
    userId:
      type: string
      description: The unique ID for the customer account.
      title: userId
    userRole:
      type: string
      enum:
        - '0'
        - '1'
        - '2'
      description: >-
        The ID of the role assigned to the Company user account as defined at [Specifying User
        Role](/developer/api-reference/rest/b2b/storefront/company/companies#specifying-user-role).
      title: userRole
    userPhone:
      type: string
      description: The phone number associated with the user's account.
      title: userPhone
    CompaniesCompanyIdUsersGetResponsesContentApplicationJsonSchemaDataListItems:
      type: object
      properties:
        firstName:
          $ref: '#/components/schemas/userFirstName'
        lastName:
          $ref: '#/components/schemas/userLastName'
        email:
          $ref: '#/components/schemas/userEmail'
        id:
          $ref: '#/components/schemas/userId'
        role:
          $ref: '#/components/schemas/userRole'
        phoneNumber:
          $ref: '#/components/schemas/userPhone'
        createdAt:
          type: string
          description: The [Unix timestamp](https://www.unixtimestamp.com/) for when the user's account was created.
        updatedAt:
          type: string
          description: The [Unix timestamp](https://www.unixtimestamp.com/) for when the user's account was most recently updated.
        uuid:
          type: string
          format: uuid
          description: A unique ID associated with the user's account. Does not match the `id` field by default.
        catalogId:
          $ref: '#/components/schemas/catalogId'
      title: CompaniesCompanyIdUsersGetResponsesContentApplicationJsonSchemaDataListItems
    CompaniesCompanyIdUsersGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/CompaniesCompanyIdUsersGetResponsesContentApplicationJsonSchemaDataListItems'
        pagination:
          $ref: '#/components/schemas/responsePagination'
      title: CompaniesCompanyIdUsersGetResponsesContentApplicationJsonSchemaData
    Companies_get-companies-companyId-users_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersGetResponsesContentApplicationJsonSchemaData'
      title: Companies_get-companies-companyId-users_Response_200
    CompaniesValidationsFrontendUserEmailsEmailGetParametersRole:
      type: string
      enum:
        - '0'
        - '1'
        - '2'
        - '3'
        - '4'
      title: CompaniesValidationsFrontendUserEmailsEmailGetParametersRole
    CompaniesValidationsFrontendUserEmailsEmailGetResponsesContentApplicationJsonSchemaDataUserInfo:
      type: object
      properties:
        firstName:
          $ref: '#/components/schemas/userFirstName'
        lastName:
          $ref: '#/components/schemas/userLastName'
        email:
          $ref: '#/components/schemas/userEmail'
        id:
          $ref: '#/components/schemas/userId'
        phoneNumber:
          $ref: '#/components/schemas/userPhone'
        role:
          $ref: '#/components/schemas/userRole'
      title: CompaniesValidationsFrontendUserEmailsEmailGetResponsesContentApplicationJsonSchemaDataUserInfo
    CompaniesValidationsFrontendUserEmailsEmailGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        isValid:
          type: string
          description: The validation status of the account as outlined above.
        userInfo:
          $ref: >-
            #/components/schemas/CompaniesValidationsFrontendUserEmailsEmailGetResponsesContentApplicationJsonSchemaDataUserInfo
      title: CompaniesValidationsFrontendUserEmailsEmailGetResponsesContentApplicationJsonSchemaData
    Companies_get-companies-validations-fronted-user-emails-email_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/CompaniesValidationsFrontendUserEmailsEmailGetResponsesContentApplicationJsonSchemaData'
      title: Companies_get-companies-validations-fronted-user-emails-email_Response_200
    UsersValidationsExistenceGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      title: UsersValidationsExistenceGetResponsesContentApplicationJsonSchemaData
    Users_get-users-validations-existence_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          default: 200
        message:
          type: string
        data:
          $ref: '#/components/schemas/UsersValidationsExistenceGetResponsesContentApplicationJsonSchemaData'
      title: Users_get-users-validations-existence_Response_200
    UsersGetParametersRole:
      type: string
      enum:
        - '0'
        - '1'
        - '2'
        - '3'
        - '4'
      title: UsersGetParametersRole
    userListItems_BASE:
      type: object
      properties:
        firstName:
          $ref: '#/components/schemas/userFirstName'
        lastName:
          $ref: '#/components/schemas/userLastName'
        email:
          $ref: '#/components/schemas/userEmail'
        id:
          $ref: '#/components/schemas/userId'
        role:
          $ref: '#/components/schemas/userRole'
        phoneNumber:
          $ref: '#/components/schemas/userPhone'
        createdAt:
          type: string
          description: The [Unix timestamp](https://www.unixtimestamp.com/) for when the user's account was created.
        updatedAt:
          type: string
          description: The [Unix timestamp](https://www.unixtimestamp.com/) for when the user's account was most recently updated.
      title: userListItems_BASE
    UsersGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/userListItems_BASE'
        pagination:
          $ref: '#/components/schemas/responsePagination'
      title: UsersGetResponsesContentApplicationJsonSchemaData
    Users_get-users_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaData'
      title: Users_get-users_Response_200
    UsersPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        userId:
          $ref: '#/components/schemas/userId'
        bcId:
          type: string
          description: The user's unique BigCommerce customer account ID. Does not match `userId` by default.
        firstName:
          $ref: '#/components/schemas/userFirstName'
        lastName:
          $ref: '#/components/schemas/userLastName'
        email:
          $ref: '#/components/schemas/userEmail'
        role:
          $ref: '#/components/schemas/userRole'
      title: UsersPostResponsesContentApplicationJsonSchemaData
    Users_post-users_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/UsersPostResponsesContentApplicationJsonSchemaData'
      title: Users_post-users_Response_200
    UsersUserIdGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        roleId:
          $ref: '#/components/schemas/userRole'
        userId:
          $ref: '#/components/schemas/userId'
        firstName:
          $ref: '#/components/schemas/userFirstName'
        lastName:
          $ref: '#/components/schemas/userLastName'
        phoneNumber:
          $ref: '#/components/schemas/userPhone'
        email:
          $ref: '#/components/schemas/userEmail'
      title: UsersUserIdGetResponsesContentApplicationJsonSchemaData
    Users_get-users-userId_Response_200:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
          format: double
          default: 200
        data:
          $ref: '#/components/schemas/UsersUserIdGetResponsesContentApplicationJsonSchemaData'
      title: Users_get-users-userId_Response_200
    UsersUserIdPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      title: UsersUserIdPutResponsesContentApplicationJsonSchemaData
    Users_put-users-userId_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          default: 200
        message:
          type: string
        data:
          $ref: '#/components/schemas/UsersUserIdPutResponsesContentApplicationJsonSchemaData'
      title: Users_put-users-userId_Response_200
    UsersUserIdDeleteResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      title: UsersUserIdDeleteResponsesContentApplicationJsonSchemaData
    Users_delete-users-userId_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          default: 200
        message:
          type: string
        data:
          $ref: '#/components/schemas/UsersUserIdDeleteResponsesContentApplicationJsonSchemaData'
      title: Users_delete-users-userId_Response_200
    OrdersGetParametersOrderBy:
      type: string
      enum:
        - createdAt
        - totalIncTax
      default: createdAt
      title: OrdersGetParametersOrderBy
    OrdersGetParametersSortBy:
      type: string
      enum:
        - DESC
        - ASC
      default: DESC
      title: OrdersGetParametersSortBy
    OrdersGetParametersIsShowMy:
      type: string
      enum:
        - '0'
        - '1'
      title: OrdersGetParametersIsShowMy
    OrdersGetParametersIncludeExtra:
      type: string
      enum:
        - '0'
        - '1'
      title: OrdersGetParametersIncludeExtra
    ResponseSuccessData:
      type: object
      properties: {}
      title: ResponseSuccessData
    orderId:
      type: string
      description: >-
        The B2B Edition internal order ID. Note that this is different from the BigCommerce order ID returned in the
        `bcOrderId` field.
      title: orderId
    createdAt:
      type: string
      format: time
      description: The [Unix timestamp](https://www.unixtimestamp.com/) for when the order was created. This is a read-only field.
      title: createdAt
    updatedAt:
      type: string
      format: time
      description: >-
        The [Unix timestamp](https://www.unixtimestamp.com/) for when the order was last updated. This is a read-only
        field.
      title: updatedAt
    isInvoiceOrder:
      type: string
      enum:
        - '0'
        - '1'
      description: |-
        Indicates whether the order is an invoice order. This is a read-only field.

        `0` indicates that the order is not an invoice order, while `1` indicates that it is an invoice order.
      title: isInvoiceOrder
    orderStatus:
      type: string
      description: >-
        The status of the order. This is a read-only field.


        See [Order Statuses](/developer/api-reference/rest/admin/management/orders/order-status) for a complete list of
        accepted status names.
      title: orderStatus
    customOrderStatus:
      type: string
      description: The customized name of the order status.
      title: customOrderStatus
    statusCode:
      type: integer
      description: >-
        The numeric code associated with the order status.


        See [Order Statuses](/developer/api-reference/rest/admin/management/orders/order-status) for a complete list of
        accepted status codes.
      title: statusCode
    totalIncTax:
      type: number
      format: double
      description: The order's total value including tax.
      title: totalIncTax
    currencyCode:
      type: string
      description: The three-letter code corresponding to the order’s currency.
      title: currencyCode
    MoneyCurrencyLocation:
      type: string
      enum:
        - left
        - right
      description: The location of the currency symbol (left or right).
      title: MoneyCurrencyLocation
    money:
      type: object
      properties:
        currency_location:
          $ref: '#/components/schemas/MoneyCurrencyLocation'
          description: The location of the currency symbol (left or right).
        currency_token:
          type: string
          description: The currency symbol.
        decimal_token:
          type: string
          description: The character used to separate decimal values in order pricing.
        decimal_places:
          type: integer
          description: The number of decimal places displayed in order pricing.
        thousands_token:
          type: string
          description: The character used to separate the hundredths and thousandths places in order pricing.
      description: Contains detailed information regarding the order's currency.
      title: money
    firstName:
      type: string
      description: The buyer's first name.
      title: firstName
    lastName:
      type: string
      description: The buyer's last name.
      title: lastName
    poNumber:
      type: string
      description: The order's Purchase Order (PO), if used.
      title: poNumber
    referenceNumber:
      type: string
      description: >-
        The value of the Additional Payment Text Input Field enabled in B2B Edition's [Checkout
        settings](https://support.bigcommerce.com/s/article/B2B-Edition-Settings).
      title: referenceNumber
    channelName:
      type: string
      description: The name of the storefront channel where the order was placed.
      title: channelName
    extraInt1:
      type: integer
      description: A legacy integer extra field configuration that does not return data in newer stores.
      title: extraInt1
    extraInt2:
      type: integer
      description: A legacy integer extra field configuration that does not return data in newer stores.
      title: extraInt2
    extraInt3:
      type: integer
      description: A legacy integer extra field configuration that does not return data in newer stores.
      title: extraInt3
    extraInt4:
      type: integer
      description: A legacy integer extra field configuration that does not return data in newer stores.
      title: extraInt4
    extraInt5:
      type: integer
      description: A legacy integer extra field configuration that does not return data in newer stores.
      title: extraInt5
    extraStr1:
      type: string
      description: A legacy string extra field configuration that does not return data in newer stores.
      title: extraStr1
    extraStr2:
      type: string
      description: A legacy string extra field configuration that does not return data in newer stores.
      title: extraStr2
    extraStr3:
      type: string
      description: A legacy string extra field configuration that does not return data in newer stores.
      title: extraStr3
    extraStr4:
      type: string
      description: A legacy string extra field configuration that does not return data in newer stores.
      title: extraStr4
    extraStr5:
      type: string
      description: A legacy string extra field configuration that does not return data in newer stores.
      title: extraStr5
    extraText:
      type: string
      description: A legacy text extra field configuration that does not return data in newer stores.
      title: extraText
    ExtraInfoItems:
      type: object
      properties:
        billingAddressId:
          type: integer
          description: The unique identifier for billing address in the Company account.
        shippingAddressId:
          type: integer
          description: The unique identifier for shipping address in the Company account.
      title: ExtraInfoItems
    extraInfo:
      type: array
      items:
        $ref: '#/components/schemas/ExtraInfoItems'
      description: Contains billing and shipping address identifiers.
      title: extraInfo
    orderData_ALL:
      type: object
      properties:
        orderId:
          $ref: '#/components/schemas/orderId'
        companyName:
          $ref: '#/components/schemas/companyName'
        createdAt:
          $ref: '#/components/schemas/createdAt'
        updatedAt:
          $ref: '#/components/schemas/updatedAt'
        isInvoiceOrder:
          $ref: '#/components/schemas/isInvoiceOrder'
        orderStatus:
          $ref: '#/components/schemas/orderStatus'
        customOrderStatus:
          $ref: '#/components/schemas/customOrderStatus'
        statusCode:
          $ref: '#/components/schemas/statusCode'
        totalIncTax:
          $ref: '#/components/schemas/totalIncTax'
        currencyCode:
          $ref: '#/components/schemas/currencyCode'
        money:
          $ref: '#/components/schemas/money'
        firstName:
          $ref: '#/components/schemas/firstName'
        lastName:
          $ref: '#/components/schemas/lastName'
        poNumber:
          $ref: '#/components/schemas/poNumber'
        referenceNumber:
          $ref: '#/components/schemas/referenceNumber'
        channelName:
          $ref: '#/components/schemas/channelName'
        extraInt1:
          $ref: '#/components/schemas/extraInt1'
        extraInt2:
          $ref: '#/components/schemas/extraInt2'
        extraInt3:
          $ref: '#/components/schemas/extraInt3'
        extraInt4:
          $ref: '#/components/schemas/extraInt4'
        extraInt5:
          $ref: '#/components/schemas/extraInt5'
        extraStr1:
          $ref: '#/components/schemas/extraStr1'
        extraStr2:
          $ref: '#/components/schemas/extraStr2'
        extraStr3:
          $ref: '#/components/schemas/extraStr3'
        extraStr4:
          $ref: '#/components/schemas/extraStr4'
        extraStr5:
          $ref: '#/components/schemas/extraStr5'
        extraText:
          $ref: '#/components/schemas/extraText'
        extraInfo:
          $ref: '#/components/schemas/extraInfo'
        extraFields:
          $ref: '#/components/schemas/extraFields'
      title: orderData_ALL
    paginator:
      type: object
      properties:
        totalCount:
          type: integer
          description: The total number of items in the response.
        offset:
          type: integer
          description: The number of items skipped in the response before the first result.
        limit:
          type: integer
          description: The maximum number of items that can be returned.
      description: Contains pagination information for the response.
      title: paginator
    OrdersGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/orderData_ALL'
          description: Contains information fields associated with each order in the response.
        paginator:
          $ref: '#/components/schemas/paginator'
      required:
        - list
        - paginator
      title: OrdersGetResponsesContentApplicationJsonSchemaData
    Orders_get-orders_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
        data:
          $ref: '#/components/schemas/OrdersGetResponsesContentApplicationJsonSchemaData'
      required:
        - data
      title: Orders_get-orders_Response_200
    orderId_REQUEST:
      type: integer
      description: The BigCommerce order ID.
      title: orderId_REQUEST
    isSaveOrderComment:
      type: string
      default: '0'
      description: |-
        Indicates whether the order comment is saved, if one exists.

        `0` indicates that the order comment is saved, while `1` indicates that it is not saved.
      title: isSaveOrderComment
    OrdersPostResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        orderId:
          $ref: '#/components/schemas/orderId'
      required:
        - orderId
      title: OrdersPostResponsesContentApplicationJsonSchemaDataItems
    Orders_post-orders_Response_200:
      type: object
      properties:
        code:
          type: integer
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
          description: Response message
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrdersPostResponsesContentApplicationJsonSchemaDataItems'
      required:
        - code
        - message
        - data
      title: Orders_post-orders_Response_200
    OrdersPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      title: OrdersPostResponsesContentApplicationJsonSchemaData
    Post-ordersRequestBadRequestError:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
          description: Error message for the request
        data:
          $ref: '#/components/schemas/OrdersPostResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Post-ordersRequestBadRequestError
    OrdersImagesGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        orderId:
          $ref: '#/components/schemas/orderId'
        imageUrl:
          type: string
          description: The image URL for a product in the order.
      required:
        - orderId
        - imageUrl
      title: OrdersImagesGetResponsesContentApplicationJsonSchemaDataItems
    Orders_get-orders-images_Response_200:
      type: object
      properties:
        code:
          type: integer
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
          description: Response message
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrdersImagesGetResponsesContentApplicationJsonSchemaDataItems'
      required:
        - code
        - message
        - data
      title: Orders_get-orders-images_Response_200
    productId:
      type: string
      description: The unique identifier for the base product.
      title: productId
    quantity:
      type: number
      format: double
      description: The quantity of the product in the order.
      title: quantity
    variantId:
      type: string
      description: The unique identifier for the product variant.
      title: variantId
    OptionListSimpleItems:
      type: object
      properties:
        optionId:
          type: integer
          description: The unique identifier for the product's variant or modifier option.
        optionValue:
          type: string
          description: The unique identifier for the product's selected option value.
        type:
          type: string
          description: The type of option, which determines how it will display on the storefront.
      title: OptionListSimpleItems
    optionList_SIMPLE:
      type: array
      items:
        $ref: '#/components/schemas/OptionListSimpleItems'
      description: Contains information about the product's options.
      title: optionList_SIMPLE
    OrdersOrderIdProductsGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        productId:
          $ref: '#/components/schemas/productId'
        quantity:
          $ref: '#/components/schemas/quantity'
        variantId:
          $ref: '#/components/schemas/variantId'
        optionList:
          $ref: '#/components/schemas/optionList_SIMPLE'
      required:
        - productId
        - quantity
        - variantId
      title: OrdersOrderIdProductsGetResponsesContentApplicationJsonSchemaDataItems
    Orders_get-orders-orderId-products_Response_200:
      type: object
      properties:
        code:
          type: integer
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
          description: Response message
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrdersOrderIdProductsGetResponsesContentApplicationJsonSchemaDataItems'
      required:
        - code
        - message
        - data
      title: Orders_get-orders-orderId-products_Response_200
    OrdersOrderIdProductsGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message for the request
      title: OrdersOrderIdProductsGetResponsesContentApplicationJsonSchemaData
    Get-orders-orderId-productsRequestNotFoundError:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
          description: Error message for the request
        data:
          $ref: '#/components/schemas/OrdersOrderIdProductsGetResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Get-orders-orderId-productsRequestNotFoundError
    OrdersOrderIdDetailsGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message for the request
      title: OrdersOrderIdDetailsGetResponsesContentApplicationJsonSchemaData
    Orders_get-orders-orderId-details_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
          description: Response message
        data:
          $ref: '#/components/schemas/OrdersOrderIdDetailsGetResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Orders_get-orders-orderId-details_Response_200
    Get-orders-orderId-detailsRequestNotFoundError:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
          description: Error message for the request
        data:
          $ref: '#/components/schemas/OrdersOrderIdDetailsGetResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Get-orders-orderId-detailsRequestNotFoundError
    productName:
      type: string
      description: The name of the product as it appears on the order.
      title: productName
    sku:
      type: string
      description: The product's SKU.
      title: sku
    product_options/items/properties/id:
      type: integer
      description: The unique numerical ID of the option; increments sequentially.
      title: product_options/items/properties/id
    product_options/items/properties/optionId:
      type: integer
      description: The numeric ID of the associated option.
      title: product_options/items/properties/optionId
    product_options/items/properties/orderProductId:
      type: integer
      description: The numeric ID of the option within the order.
      title: product_options/items/properties/orderProductId
    optionList_SIMPLE/items/properties/optionId:
      type: integer
      description: The unique identifier for the product's variant or modifier option.
      title: optionList_SIMPLE/items/properties/optionId
    product_options/items/properties/displayName:
      type: string
      description: Alias for `displayNameCustomer`. The product option name that is shown to customer in the storefront.
      title: product_options/items/properties/displayName
    product_options/items/properties/displayNameCustomer:
      type: string
      description: The product option name that is shown to customer in storefront.
      title: product_options/items/properties/displayNameCustomer
    product_options/items/properties/displayNameMerchant:
      type: string
      description: The internal option name in the control panel.
      title: product_options/items/properties/displayNameMerchant
    product_options/items/properties/displayValue:
      type: string
      description: Alias for `displayValueCustomer`. The product option value that is shown to customer in storefront.
      title: product_options/items/properties/displayValue
    product_options/items/properties/displayValueCustomer:
      type: string
      description: The product option value that is shown to customer in storefront.
      title: product_options/items/properties/displayValueCustomer
    product_options/items/properties/displayValueMerchant:
      type: string
      description: The internal option value name in the control panel.
      title: product_options/items/properties/displayValueMerchant
    product_options/items/properties/value:
      type: string
      description: The unique identifier for the product's selected option value.
      title: product_options/items/properties/value
    product_options/items/properties/type:
      description: Any type
      title: product_options/items/properties/type
    product_options/items/properties/name:
      type: string
      description: The option's name, as used internally. Options given a duplicate name have a numeric string added to them.
      title: product_options/items/properties/name
    product_options/items/properties/displayStyle:
      type: string
      description: Indicates how a multiple choice option is displayed on the storefront.
      title: product_options/items/properties/displayStyle
    OrderedProductsGetResponsesContentApplicationJsonSchemaDataListItemsOptionListItems:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/product_options/items/properties/id'
        option_id:
          $ref: '#/components/schemas/product_options/items/properties/optionId'
        order_product_id:
          $ref: '#/components/schemas/product_options/items/properties/orderProductId'
        product_option_id:
          $ref: '#/components/schemas/optionList_SIMPLE/items/properties/optionId'
        display_name:
          $ref: '#/components/schemas/product_options/items/properties/displayName'
        display_name_customer:
          $ref: '#/components/schemas/product_options/items/properties/displayNameCustomer'
        display_name_merchant:
          $ref: '#/components/schemas/product_options/items/properties/displayNameMerchant'
        display_value:
          $ref: '#/components/schemas/product_options/items/properties/displayValue'
        display_value_customer:
          $ref: '#/components/schemas/product_options/items/properties/displayValueCustomer'
        display_value_merchant:
          $ref: '#/components/schemas/product_options/items/properties/displayValueMerchant'
        value:
          $ref: '#/components/schemas/product_options/items/properties/value'
        type:
          $ref: '#/components/schemas/product_options/items/properties/type'
        name:
          $ref: '#/components/schemas/product_options/items/properties/name'
        display_style:
          $ref: '#/components/schemas/product_options/items/properties/displayStyle'
      required:
        - id
        - option_id
        - order_product_id
        - product_option_id
        - display_name
        - display_name_customer
        - display_name_merchant
        - display_value
        - display_value_customer
        - display_value_merchant
        - value
        - type
        - name
        - display_style
      title: OrderedProductsGetResponsesContentApplicationJsonSchemaDataListItemsOptionListItems
    productBrandName:
      type: string
      description: The name of the brand associated with the product.
      title: productBrandName
    OrderedProductsGetResponsesContentApplicationJsonSchemaDataListItemsOrdersInfoItems:
      type: object
      properties:
        order_id:
          type: number
          format: double
          description: The unique identifier for the B2B Edition order record
        quantity:
          $ref: '#/components/schemas/quantity'
        ordered_at:
          type: number
          format: double
          description: The [Unix timestamp](https://www.unixtimestamp.com/) for when the order was placed.
        bc_order_id:
          $ref: '#/components/schemas/orderId'
      title: OrderedProductsGetResponsesContentApplicationJsonSchemaDataListItemsOrdersInfoItems
    OrderedProductsGetResponsesContentApplicationJsonSchemaDataListItems:
      type: object
      properties:
        orderProductId:
          type: string
          description: >-
            The unique identifier for the product appearing on the order. Note that this is different from the
            `productId`.
        productName:
          $ref: '#/components/schemas/productName'
        sku:
          $ref: '#/components/schemas/sku'
        productId:
          $ref: '#/components/schemas/productId'
        variantId:
          $ref: '#/components/schemas/variantId'
        lastOrdered:
          type: string
          description: The [Unix timestamp](https://www.unixtimestamp.com/) for the last time the buyer ordered the product.
        optionList:
          type: array
          items:
            $ref: '#/components/schemas/OrderedProductsGetResponsesContentApplicationJsonSchemaDataListItemsOptionListItems'
          description: Contains information about the product's options.
        optionSelections:
          $ref: '#/components/schemas/optionList_SIMPLE'
        orderedTimes:
          type: string
          description: The number of times that the buyer has ordered the product.
        lastOrderedItems:
          type: string
          description: The quantity of the product purchased in the buyer's most recent order.
        productBrandName:
          $ref: '#/components/schemas/productBrandName'
        ordersInfo:
          type: array
          items:
            $ref: '#/components/schemas/OrderedProductsGetResponsesContentApplicationJsonSchemaDataListItemsOrdersInfoItems'
          description: Contains information about all orders containing the product.
        imageUrl:
          type: string
          description: The image URL for a product in the order.
      required:
        - orderProductId
        - productName
        - sku
        - productId
        - variantId
        - lastOrdered
        - orderedTimes
        - lastOrderedItems
        - productBrandName
      title: OrderedProductsGetResponsesContentApplicationJsonSchemaDataListItems
    OrderedProductsGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        paginator:
          $ref: '#/components/schemas/paginator'
        list:
          type: array
          items:
            $ref: '#/components/schemas/OrderedProductsGetResponsesContentApplicationJsonSchemaDataListItems'
          description: Contains information fields associated with each product in the response.
      required:
        - paginator
        - list
      title: OrderedProductsGetResponsesContentApplicationJsonSchemaData
    Orders_get-ordered-products_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
          description: Response message
        data:
          $ref: '#/components/schemas/OrderedProductsGetResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Orders_get-ordered-products_Response_200
    RfqGetParametersSortBy:
      type: string
      enum:
        - updatedAt
        - createdAt
        - expiredAt
        - quoteNumber
        - title
        - salesRep
        - status
      default: updatedAt
      title: RfqGetParametersSortBy
    RfqGetParametersOrderBy:
      type: string
      enum:
        - ASC
        - DESC
      default: DESC
      title: RfqGetParametersOrderBy
    RfqGetParametersStatus:
      type: string
      enum:
        - '1'
        - '4'
        - '5'
      title: RfqGetParametersStatus
    quoteId:
      type: integer
      description: The internal numeric ID of the sales quote.
      title: quoteId
    quoteChannelName:
      type: string
      description: The name of the storefront channel associated with the quote.
      title: quoteChannelName
    quoteTitle:
      type: string
      description: The external title given to the quote.
      title: quoteTitle
    quoteReference:
      type: string
      description: An identifier for the quote that can be supplied by the sales rep or the buyer, such as a Purchase Order number.
      title: quoteReference
    quoteExpired:
      type: integer
      description: >-
        The [Unix timestamp](https://www.unixtimestamp.com/) for when the sales quote expires. This is a read-only
        field.
      title: quoteExpired
    quoteSubtotal:
      type: number
      format: double
      description: The quoted total after discounts and before shipping and tax.
      title: quoteSubtotal
    quoteStatus:
      type: string
      enum:
        - '1'
        - '4'
        - '5'
      description: >-
        The numeric ID associated with the quote's status. See [Quote
        Statuses](/developer/api-reference/rest/b2b/storefront/request-for-quote#quote-statuses) to learn about the
        statuses that correspond to each ID.
      title: quoteStatus
    bcOrderId:
      type: integer
      description: The BigCommerce order ID associated with the sales quote.
      title: bcOrderId
    quoteChannel:
      type: integer
      description: >-
        The storefront channel ID associated with the quote. This is required if your store has multiple storefront
        channels. Use '1' for your store's default storefront channel.
      title: quoteChannel
    CurrencyResponseLocation:
      type: string
      enum:
        - left
        - right
      description: Determines whether the currency symbol is added to the left or the right of quote pricing.
      title: CurrencyResponseLocation
    currency_RESPONSE:
      type: object
      properties:
        location:
          $ref: '#/components/schemas/CurrencyResponseLocation'
          description: Determines whether the currency symbol is added to the left or the right of quote pricing.
        token:
          type: string
          description: The currency symbol.
        decimalToken:
          type: string
          description: The character used to separate decimal values in quote pricing.
        decimalPlaces:
          type: number
          format: double
          description: The number of decimal places displayed in quote pricing.
        thousandsToken:
          type: string
          description: The character used to separate the hundredths and thousandths places in quote pricing.
        currencyCode:
          type: string
          description: The three-letter code corresponding to the quote's currency
        currencyExchangeRate:
          type: number
          format: double
          description: >-
            Overrides the built-in exchange rate between your store's default currency and the quote's selected
            currency. If left blank, the exchange rate defined in your store's settings is used.
      description: Contains detailed information regarding the quote's currency.
      title: currency_RESPONSE
    QuoteDataListExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
          description: The name of the quote extra field.
        fieldValue:
          type: string
          description: The value of the quote extra field.
      description: Contains information about extra fields on the quote.
      title: QuoteDataListExtraFieldsItems
    quoteData_LIST:
      type: object
      properties:
        quoteId:
          $ref: '#/components/schemas/quoteId'
        company:
          type: string
          description: >-
            The name of the Company account associated with the buyer on the quote. If the quote is for a B2C customer
            or guest shopper, this field is blank.
        salesRep:
          type: string
          description: The sales rep user assigned to the quote.
        updatedAt:
          type: integer
          description: The [Unix timestamp](https://www.unixtimestamp.com/) when the quote was last modified.
        contactName:
          type: string
          description: The buyer’s full name.
        contactEmail:
          type: string
          description: The buyer’s email address.
        channelName:
          $ref: '#/components/schemas/quoteChannelName'
        quoteTitle:
          $ref: '#/components/schemas/quoteTitle'
        referenceNumber:
          $ref: '#/components/schemas/quoteReference'
        expiredAt:
          $ref: '#/components/schemas/quoteExpired'
        subtotal:
          $ref: '#/components/schemas/quoteSubtotal'
        quoteNumber:
          type: string
          description: The quote identifier that is visible in the B2B Edition control panel and the Buyer Portal.
        createdBy:
          type: string
          description: The name of the sales rep or buyer who created the quote.
        createdAt:
          type: integer
          description: The [Unix timestamp](https://www.unixtimestamp.com/) for when the sales quote was created.
        status:
          $ref: '#/components/schemas/quoteStatus'
        bcOrderId:
          $ref: '#/components/schemas/bcOrderId'
        orderId:
          $ref: '#/components/schemas/orderId'
        channelId:
          $ref: '#/components/schemas/quoteChannel'
        currency:
          $ref: '#/components/schemas/currency_RESPONSE'
        extraFields:
          type: array
          items:
            $ref: '#/components/schemas/QuoteDataListExtraFieldsItems'
      title: quoteData_LIST
    RfqGetResponsesContentApplicationJsonSchemaDataPagination:
      type: object
      properties:
        totalCount:
          type: integer
          description: The total number of items in the full response.
        offset:
          type: integer
          default: '0'
          description: The number of eligible results skipped before the first result in the response.
        limit:
          type: integer
          default: '10'
          description: The number of records returned per page.
      title: RfqGetResponsesContentApplicationJsonSchemaDataPagination
    RfqGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/quoteData_LIST'
        pagination:
          $ref: '#/components/schemas/RfqGetResponsesContentApplicationJsonSchemaDataPagination'
      title: RfqGetResponsesContentApplicationJsonSchemaData
    Quotes_get-rfq_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
        data:
          $ref: '#/components/schemas/RfqGetResponsesContentApplicationJsonSchemaData'
      title: Quotes_get-rfq_Response_200
    quoteNotes:
      type: string
      description: |-
        The quote's buyer-facing notes. Use the newline character `
        ` to separate each line of text.
      title: quoteNotes
    quoteLegalTerms:
      type: string
      description: >-
        The quote's terms and conditions. Use the newline character to separate each line of text. Omitting this field
        or leaving it blank does not add your store's default terms and conditions to the quote. Instead, the quote will
        not display any terms.
      title: quoteLegalTerms
    quoteGrandTotal:
      type: number
      format: double
      description: The quoted total after discounts, shipping, and tax are applied.
      title: quoteGrandTotal
    quoteDiscount:
      type: number
      format: double
      description: The total value of discounts applied to the quote. This is presented as a fixed value instead of a percentage.
      title: quoteDiscount
    QuoteDataPostIsBackendUser:
      type: string
      enum:
        - 0 (Quote is created by a buyer or Super Admin)
        - 1 (Quote is created by a backend system user)
      description: >-
        Indicates whether the quote was created by a frontend user like a buyer or Super Admin, or it was created by a
        backend user like Sales Staff.
      title: QuoteDataPostIsBackendUser
    OptionListItems:
      type: object
      properties:
        optionId:
          type: integer
          description: The unique identifier for the line item's variant or modifier option.
        optionName:
          type: integer
          description: The name of the line item's variant or modifier option.
        optionLabel:
          type: string
          description: The name of the line item's selected option value.
        optionValue:
          type: integer
          description: The unique identifier for the line item's selected option value.
      title: OptionListItems
    optionList:
      type: array
      items:
        $ref: '#/components/schemas/OptionListItems'
      description: Variant and modifier option information for the line item.
      title: optionList
    QuoteDataPostProductListItems:
      type: object
      properties:
        sku:
          type: string
          description: The line item's SKU.
        basePrice:
          type: number
          format: double
          description: The line item's price before any discounts are applied.
        discount:
          type: number
          format: double
          description: The discount percentage applied to the line item.
        offeredPrice:
          type: number
          format: double
          description: The line item's price after any discounts are applied.
        quantity:
          type: integer
          description: The quantity of the line item.
        productId:
          type: integer
          description: The unique identifier for the base line item.
        variantId:
          type: integer
          description: The unique identifier for the line item variant.
        imageUrl:
          type: string
          description: The URL for the line item image on your storefront.
        orderQuantityMaximum:
          type: integer
          description: The maximum number of line item units that can be added to the quote.
        orderQuantityMinimum:
          type: integer
          description: The minimum number of line item units that can be added to the quote.
        productName:
          type: string
          description: The name of the line item.
        options:
          $ref: '#/components/schemas/optionList'
      title: QuoteDataPostProductListItems
    CurrencyRequestLocation:
      type: string
      enum:
        - left
        - right
      description: Determines whether the currency symbol is added to the left or the right of quote pricing.
      title: CurrencyRequestLocation
    currency_REQUEST:
      type: object
      properties:
        location:
          $ref: '#/components/schemas/CurrencyRequestLocation'
          description: Determines whether the currency symbol is added to the left or the right of quote pricing.
        token:
          type: string
          description: The currency symbol.
        decimalToken:
          type: string
          description: The character used to separate decimal values in quote pricing.
        decimalPlaces:
          type: number
          format: double
          description: The number of decimal places displayed in quote pricing.
        thousandsToken:
          type: string
          description: The character used to separate the hundredths and thousandths places in quote pricing.
        currencyCode:
          type: string
          description: The three-letter code corresponding to the quote's currency
      required:
        - location
        - token
        - decimalToken
        - decimalPlaces
        - thousandsToken
      description: Contains detailed information regarding the quote's currency.
      title: currency_REQUEST
    QuoteDataPostContactInfo:
      type: object
      properties:
        name:
          type: string
          description: The buyer's full name.
        email:
          type: string
          description: The buyer's email address.
        companyName:
          type: string
          description: >-
            The name of the Company associated with the quote's buyer. For B2C customers and guest shoppers, this is the
            name of their business, if provided.
        phoneNumber:
          type: string
          description: The buyer's phone number.
      required:
        - name
        - email
      description: This object contains the contact information for the buyer in the quote.
      title: QuoteDataPostContactInfo
    QuoteDataPostShippingAddress:
      type: object
      properties:
        address:
          type: string
          description: The first line of the address."
        apartment:
          type: string
          description: The second line of the address.
        city:
          type: string
          description: The city on the address.
        state:
          type: string
          description: The full name of the state on the address.
        zipCode:
          type: string
          description: The postal code on the address.
        country:
          type: string
          description: The full name of the country on the address.
      required:
        - address
        - apartment
        - city
        - state
        - zipCode
        - country
      description: Contains information for the shipping address on the quote.
      title: QuoteDataPostShippingAddress
    quoteData_POST:
      type: object
      properties:
        companyId:
          type: number
          format: double
          description: >-
            The unique identifier for the Company account associated with the quote. This field is required when
            creating a quote for a Company account.
        expiredAt:
          type: string
          description: Use '%m/%d/%Y' format when entering the expiration date.
        storeHash:
          $ref: '#/components/schemas/storeHash'
        quoteTitle:
          $ref: '#/components/schemas/quoteTitle'
        referenceNumber:
          $ref: '#/components/schemas/quoteReference'
        notes:
          $ref: '#/components/schemas/quoteNotes'
        legalTerms:
          $ref: '#/components/schemas/quoteLegalTerms'
        grandTotal:
          $ref: '#/components/schemas/quoteGrandTotal'
        discount:
          $ref: '#/components/schemas/quoteDiscount'
        subtotal:
          $ref: '#/components/schemas/quoteSubtotal'
        userEmail:
          type: string
          format: email
          description: The email address of the buyer associated with the quote.
        isBackendUser:
          $ref: '#/components/schemas/QuoteDataPostIsBackendUser'
          description: >-
            Indicates whether the quote was created by a frontend user like a buyer or Super Admin, or it was created by
            a backend user like Sales Staff.
        productList:
          type: array
          items:
            $ref: '#/components/schemas/QuoteDataPostProductListItems'
          description: Line item information for the quote.
        currency:
          $ref: '#/components/schemas/currency_REQUEST'
        contactInfo:
          $ref: '#/components/schemas/QuoteDataPostContactInfo'
          description: This object contains the contact information for the buyer in the quote.
        shippingAddress:
          $ref: '#/components/schemas/QuoteDataPostShippingAddress'
          description: Contains information for the shipping address on the quote.
        bcCustomerId:
          type: integer
          description: The unique ID for the customer account.
        channelId:
          $ref: '#/components/schemas/quoteChannel'
      required:
        - companyId
        - storeHash
        - grandTotal
        - discount
        - userEmail
        - productList
        - contactInfo
      title: quoteData_POST
    RfqPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errorMsg:
          type: string
          default: Store hash not allow none
      title: RfqPostResponsesContentApplicationJsonSchemaData
    Quotes_post-rfq_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
        data:
          $ref: '#/components/schemas/RfqPostResponsesContentApplicationJsonSchemaData'
      title: Quotes_post-rfq_Response_200
    Post-rfqRequestBadRequestError:
      type: object
      properties:
        code:
          type: integer
          default: '40020'
          description: HTTP Response Code
        message:
          type: string
          default: Bad Requests Error
        data:
          $ref: '#/components/schemas/RfqPostResponsesContentApplicationJsonSchemaData'
      title: Post-rfqRequestBadRequestError
    quoteData_RESPONSE/allOf/1/properties/quoteNumber:
      type: string
      description: The quote identifier that is visible in the B2B Edition control panel and the Buyer Portal.
      title: quoteData_RESPONSE/allOf/1/properties/quoteNumber
    QuoteDataDetailExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
          description: The name of the quote extra field.
        fieldValue:
          type: string
          description: The value of the quote extra field.
      description: Contains information about extra fields on the quote.
      title: QuoteDataDetailExtraFieldsItems
    quoteContactInfo:
      type: object
      properties:
        name:
          type: string
          description: The buyer's full name.
        email:
          type: string
          description: The buyer's email address.
        companyName:
          type: string
          description: >-
            The name of the Company associated with the quote's buyer. For B2C customers and guest shoppers, this is the
            name of their business, if provided.
        phoneNumber:
          type: string
          description: The buyer's phone number.
      description: This object contains the contact information for the buyer in the quote.
      title: quoteContactInfo
    QuoteDataDetailShippingAddress:
      type: object
      properties:
        address:
          type: string
          description: The first line of the address."
        apartment:
          type: string
          description: The second line of the address.
        city:
          type: string
          description: The city on the address.
        state:
          type: string
          description: The full name of the state on the address.
        zipCode:
          type: string
          description: The postal code on the address.
        country:
          type: string
          description: The full name of the country on the address.
        lastName:
          type: string
          description: The buyer's last name on the address.
        addressId:
          type: string
          description: The unique identifier for a Company account's address.
        label:
          type: string
          description: The address label specified in the Company account.
        firstName:
          type: string
          description: The buyer's first name on the address.
        stateCode:
          type: string
          description: The two-letter code for the state on the address.
        countryCode:
          type: string
          description: The two-letter code for the country on the address.
        phoneNumber:
          type: string
          description: The phone number on the address.
      description: Contains information for the shipping address on the quote.
      title: QuoteDataDetailShippingAddress
    quoteBillingAddress:
      type: object
      properties:
        address:
          type: string
          description: The first line of the address."
        apartment:
          type: string
          description: The second line of the address.
        city:
          type: string
          description: The city on the address.
        state:
          type: string
          description: The full name of the state on the address.
        zipCode:
          type: string
          description: The postal code on the address.
        country:
          type: string
          description: The full name of the country on the address.
        lastName:
          type: string
          description: The buyer's last name on the address.
        addressId:
          type: string
          description: The unique identifier for a Company account's address.
        label:
          type: string
          description: The address label specified in the Company account.
        firstName:
          type: string
          description: The buyer's first name on the address.
        stateCode:
          type: string
          description: The two-letter code for the state on the address.
        countryCode:
          type: string
          description: The two-letter code for the country on the address.
        phoneNumber:
          type: string
          description: The phone number on the address.
      description: Contains information for the shipping address on the quote.
      title: quoteBillingAddress
    QuoteDataDetailTrackingHistory:
      type: object
      properties:
        date:
          type: integer
          description: The [Unix timestamp](https://www.unixtimestamp.com/) for when the message was sent.
        read:
          type: boolean
          description: >-
            Indicates whether or not a message has been read by the sender. For example, a `read` value of `true` for a
            message sent by a customer means that the Sales Staff user has read it.
        role:
          type: string
          description: >-
            The sender of the message. Buyers are designated as `Customer:` while Sales Staff users are designated as
            `Sales rep:`
        message:
          type: string
          description: The contents of the message.
      description: Contains information about in-quote messages sent by the buyer and the assigned Sales Staff user.
      title: QuoteDataDetailTrackingHistory
    QuoteDataDetailProductListItemsInventoryTracking:
      type: string
      enum:
        - none
        - product
        - variant
      description: >-
        Indicates whether the line item’s inventory is tracked on the product (product) or variant level (option), or if
        it is not tracked (none).
      title: QuoteDataDetailProductListItemsInventoryTracking
    QuoteDataDetailProductListItemsType:
      type: string
      enum:
        - physical
        - digital
      description: Indicates whether the line item is a physical or digital product.
      title: QuoteDataDetailProductListItemsType
    QuoteDataDetailProductListItemsAvailability:
      type: string
      enum:
        - available
        - disabled
      description: Indicates whether or not the line item is visible on the storefront.
      title: QuoteDataDetailProductListItemsAvailability
    QuoteDataDetailProductListItemsPurchasingDisabled:
      type: string
      enum:
        - available
        - disabled
      description: >-
        Indicates whether or not the line item is purchasable on the storefront. Non-purchasable products can still be
        added to a quote as [custom items](#custom-items).
      title: QuoteDataDetailProductListItemsPurchasingDisabled
    QuoteDataDetailProductListItems:
      type: object
      properties:
        sku:
          type: string
          description: The line item's SKU.
        basePrice:
          type: number
          format: double
          description: The line item's price before any discounts are applied.
        discount:
          type: number
          format: double
          description: The discount percentage applied to the line item.
        offeredPrice:
          type: number
          format: double
          description: The line item's price after any discounts are applied.
        quantity:
          type: integer
          description: The quantity of the line item.
        productId:
          type: integer
          description: The unique identifier for the base line item.
        variantId:
          type: integer
          description: The unique identifier for the line item variant.
        imageUrl:
          type: string
          description: The URL for the line item image on your storefront.
        orderQuantityMaximum:
          type: integer
          description: The maximum number of line item units that can be added to the quote.
        orderQuantityMinimum:
          type: integer
          description: The minimum number of line item units that can be added to the quote.
        productName:
          type: string
          description: The name of the line item.
        options:
          $ref: '#/components/schemas/optionList'
        notes:
          type: string
          description: The buyer-facing notes added to line items in the quote.
        purchaseHandled:
          type: boolean
          description: >-
            Indicates whether or not the line item is a [custom item](#custom-items). A value of `true` indicates the
            line item is a custom item.
        costPrice:
          type: number
          format: double
          description: The line item’s cost price.
        inventoryTracking:
          $ref: '#/components/schemas/QuoteDataDetailProductListItemsInventoryTracking'
          description: >-
            Indicates whether the line item’s inventory is tracked on the product (product) or variant level (option),
            or if it is not tracked (none).
        inventoryLevel:
          type: number
          format: double
          description: The available stock for the line item.
        type:
          $ref: '#/components/schemas/QuoteDataDetailProductListItemsType'
          description: Indicates whether the line item is a physical or digital product.
        isFreeShippig:
          type: boolean
          description: Indicates whether the line item has product-level free shipping.
        availability:
          $ref: '#/components/schemas/QuoteDataDetailProductListItemsAvailability'
          description: Indicates whether or not the line item is visible on the storefront.
        isPriceHidden:
          type: boolean
          description: Indicates whether or not the line item’s price is hidden on the storefront.
        purchasingDisabled:
          $ref: '#/components/schemas/QuoteDataDetailProductListItemsPurchasingDisabled'
          description: >-
            Indicates whether or not the line item is purchasable on the storefront. Non-purchasable products can still
            be added to a quote as [custom items](#custom-items).
        foundInBc:
          type: boolean
          description: Indicates whether or not the line item is present in your store’s catalog.
        hasInvalidOptions:
          type: boolean
          description: >-
            Indicates whether or not the line item has product options which were removed from your store’s catalog. If
            a line item has invalid options in an unpurchased quote, it must be updated before the buyer can take it to
            checkout.
        productUrl:
          type: string
          description: The relative URL of the product with respect to your store's domain.
      title: QuoteDataDetailProductListItems
    quoteData_ORDERED/properties/shippingTotal:
      type: number
      format: double
      description: The total cost of shipping on the quote.
      title: quoteData_ORDERED/properties/shippingTotal
    quoteData_ORDERED/properties/taxTotal:
      type: number
      format: double
      description: The tax value applied to the quote's total.
      title: quoteData_ORDERED/properties/taxTotal
    quoteData_ORDERED/properties/shippingMethod:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the shipping method.
        type:
          description: >-
            The type of shipping method added to the quote. Custom shipping methods appear as `custom`, while static and
            real-time shipping methods appear as `provider_methodtype`, like `shipping_flatrate` or
            `usps_twodaydomestic`.
        description:
          type: string
          description: The name of the shipping method.
        imageUrl:
          type: string
          description: The URL of the logo image for the shipping provider, if the quote has a real-time shipping method.
        transitTime:
          type: string
          description: The estimated delivery time for a real-time shipping method.
        cost:
          type: number
          format: double
          description: The shipping rate on the quote.
        additionalDescription:
          type: string
          description: A secondary description found on some real-time shipping methods.
      description: Contains information on the quote's shipping method.
      title: quoteData_ORDERED/properties/shippingMethod
    quoteStorefrontAttachFiles:
      type: object
      properties:
        id:
          type: integer
          description: The unique identifier assigned to the file attachment.
        fileName:
          type: string
          description: The attachment’s file name.
        fileType:
          type: string
          description: The attachment’s file type.
        fileUrl:
          type: string
          description: The download link for the attachment file.
      description: Information on files attached to the quote by the buyer.
      title: quoteStorefrontAttachFiles
    quoteBackendAttachFiles:
      type: object
      properties:
        id:
          type: integer
          description: The unique identifier assigned to the file attachment.
        fileName:
          type: string
          description: The attachment’s file name.
        fileType:
          type: string
          description: The attachment’s file type.
        fileUrl:
          type: string
          description: The download link for the attachment file.
      description: Information on files attached to the quote by the buyer.
      title: quoteBackendAttachFiles
    storeInfo:
      type: object
      properties:
        storeName:
          type: string
          description: The name of the storefront.
        storeAddress:
          type: string
          description: |-
            The storefront's full origin address. The newline character `
            ` is used to separate each line of text.
        storeCountry:
          type: string
          description: The full name of the storefront's origin country.
        storeLogo:
          type: string
          description: The image URL for the storefront logo.
        storeUrl:
          type: string
          description: The storefront's URL.
      title: storeInfo
    companyInfo:
      type: object
      properties:
        companyId:
          type: string
          description: The unique identifier for the Company account.
        companyName:
          type: string
          description: The Company account name.
        companyAddress:
          type: string
          description: The first line of the primary address for the Company account.
        copmanyCountry:
          type: string
          description: The full name of the country on the primary address of the Company account.
        companyState:
          type: string
          description: The state of the primary address for the Company account, if applicable.
        companyCity:
          type: string
          description: The city of the primary address for the Company account.
        companyZipCode:
          type: string
          description: The postal code of the primary address for the Company account.
        phoneNumber:
          type: string
          description: The phone number associated with the Company account.
        companyEmail:
          type: string
          description: The primary email address of the Company account.
        bcId:
          type: integer
          description: The unique identifier for the customer group assigned to the Company account.
      title: companyInfo
    salesRepInfo:
      type: object
      properties:
        salesRepName:
          type: string
          description: The name of the sales rep.
        salesRepEmail:
          type: string
          description: The sales rep's email address.
        salesRepPhoneNumber:
          type: string
          description: The sales rep's phone number.
      title: salesRepInfo
    ExtraFieldsInfoFieldType:
      type: string
      enum:
        - '0'
        - '1'
        - '2'
        - '3'
      description: |-
        The type of data that can be added as the extra field's value.

        | Value | Type |
        | --- | --- |
        | `0` | text |
        | `1` | multi-line text |
        | `2` | numbers |
        | `3` | dropdown |
      title: ExtraFieldsInfoFieldType
    ExtraFieldsInfoConfigType:
      type: string
      enum:
        - 1 (built-in)
        - 2 (user-defined)
      description: Indicates whether an extra field is built-in or user-defined.
      title: ExtraFieldsInfoConfigType
    ExtraFieldsInfoListOfValue:
      type: object
      properties: {}
      description: >-
        The available options that can be selected for the extra field. This only applies to extra fields with a
        fieldType of 3 (dropdown).
      title: ExtraFieldsInfoListOfValue
    ExtraFieldsInfoValueConfigsListOfValue:
      type: object
      properties: {}
      description: >-
        The available options that can be selected for the extra field. This only applies to extra fields with a
        fieldType of 3 (dropdown).
      title: ExtraFieldsInfoValueConfigsListOfValue
    ExtraFieldsInfoValueConfigs:
      type: object
      properties:
        defaultValue:
          type: string
          description: The default value configured for the extra field.
        listOfValue:
          $ref: '#/components/schemas/ExtraFieldsInfoValueConfigsListOfValue'
          description: >-
            The available options that can be selected for the extra field. This only applies to extra fields with a
            fieldType of 3 (dropdown).
        maximumLimit:
          type: integer
          description: The maxmimum number of characters of the maximum number of rows, depending on the field type.
      description: >-
        The extra field configuration as an object. The fields `defaultValue` and `listOfValue` match those in the main
        object body. The field `maximumLimit` matches `maximumLength` or `numberOfRows` in the main body.
      title: ExtraFieldsInfoValueConfigs
    extraFieldsInfo:
      type: object
      properties:
        id:
          type: integer
          description: The unique identifier for the extra field.
        uuid:
          type: string
          description: An external ID assigned to the extra field in a third-party system, such as an ERP.
        fieldName:
          type: string
          description: The name of the quote extra field.
        fieldType:
          $ref: '#/components/schemas/ExtraFieldsInfoFieldType'
          description: |-
            The type of data that can be added as the extra field's value.

            | Value | Type |
            | --- | --- |
            | `0` | text |
            | `1` | multi-line text |
            | `2` | numbers |
            | `3` | dropdown |
        isRequired:
          type: boolean
          description: Indicates whether or not the extra field must be filled to create a quote.
        isUnique:
          type: boolean
          description: >-
            Indicates whether or not unique values are required for the extra field. Specifically if `true`, no two
            quotes may have the same value for the field.
        visibleToEnduser:
          type: boolean
          description: Indicates whether or not the extra field is visible on the storefront.
        configType:
          $ref: '#/components/schemas/ExtraFieldsInfoConfigType'
          description: Indicates whether an extra field is built-in or user-defined.
        defaultValue:
          type: string
          description: The default value configured for the extra field.
        labelName:
          type: string
          description: The buyer-visible name of the quote extra field.
        listOfValue:
          $ref: '#/components/schemas/ExtraFieldsInfoListOfValue'
          description: >-
            The available options that can be selected for the extra field. This only applies to extra fields with a
            fieldType of 3 (dropdown).
        maximumLength:
          type: integer
          description: >-
            The maximum character length of the value entered for the extra field. This only applies to extra fields
            with a `fieldType` of `0` (text).
        nubmerOfRows:
          type: integer
          description: >-
            The maximum number or text rows for the value entered for the extra field. This only applies to extra fields
            with a `fieldType` of `1` (multi-line text).
        valueConfigs:
          $ref: '#/components/schemas/ExtraFieldsInfoValueConfigs'
          description: >-
            The extra field configuration as an object. The fields `defaultValue` and `listOfValue` match those in the
            main object body. The field `maximumLimit` matches `maximumLength` or `numberOfRows` in the main body.
      title: extraFieldsInfo
    quoteLogo:
      type: string
      description: The image URL of the store logo added to quote emails and PDFs.
      title: quoteLogo
    quoteData_DETAIL:
      type: object
      properties:
        quoteNumber:
          $ref: '#/components/schemas/quoteData_RESPONSE/allOf/1/properties/quoteNumber'
          description: The quote identifier that is visible in the B2B Edition control panel and the Buyer Portal.
        channelId:
          $ref: '#/components/schemas/quoteChannel'
        channelName:
          $ref: '#/components/schemas/quoteChannelName'
        discount:
          $ref: '#/components/schemas/quoteDiscount'
        grandTotal:
          $ref: '#/components/schemas/quoteGrandTotal'
        quoteTitle:
          $ref: '#/components/schemas/quoteTitle'
        referenceNumber:
          $ref: '#/components/schemas/quoteReference'
        expiredAt:
          $ref: '#/components/schemas/quoteExpired'
        subtotal:
          $ref: '#/components/schemas/quoteSubtotal'
        createdBy:
          type: string
          description: The name of the sales rep or buyer who created the quote.
        createdAt:
          type: integer
          description: The [Unix timestamp](https://www.unixtimestamp.com/) for when the sales quote was created.
        status:
          $ref: '#/components/schemas/quoteStatus'
        bcOrderId:
          $ref: '#/components/schemas/bcOrderId'
        orderId:
          $ref: '#/components/schemas/orderId'
        currency:
          $ref: '#/components/schemas/currency_RESPONSE'
        extraFields:
          type: array
          items:
            $ref: '#/components/schemas/QuoteDataDetailExtraFieldsItems'
        contactInfo:
          $ref: '#/components/schemas/quoteContactInfo'
        shippingAddress:
          $ref: '#/components/schemas/QuoteDataDetailShippingAddress'
          description: Contains information for the shipping address on the quote.
        billingAddress:
          $ref: '#/components/schemas/quoteBillingAddress'
        recipients:
          type: array
          items:
            type: string
        trackingHistory:
          $ref: '#/components/schemas/QuoteDataDetailTrackingHistory'
          description: Contains information about in-quote messages sent by the buyer and the assigned Sales Staff user.
        productList:
          type: array
          items:
            $ref: '#/components/schemas/QuoteDataDetailProductListItems'
          description: Line item information for the quote.
        notes:
          $ref: '#/components/schemas/quoteNotes'
        legalTerms:
          $ref: '#/components/schemas/quoteLegalTerms'
        shippingTotal:
          $ref: '#/components/schemas/quoteData_ORDERED/properties/shippingTotal'
        taxTotal:
          $ref: '#/components/schemas/quoteData_ORDERED/properties/taxTotal'
        shippingMethod:
          $ref: '#/components/schemas/quoteData_ORDERED/properties/shippingMethod'
        storeFrontAttachFiles:
          $ref: '#/components/schemas/quoteStorefrontAttachFiles'
        backendAttachFiles:
          $ref: '#/components/schemas/quoteBackendAttachFiles'
        displayDiscount:
          type: boolean
          description: >-
            Determines if buyers can see quoted discount values in the Buyer Portal, or if they only see the quoted
            prices.
        allowCheckout:
          type: boolean
          description: Determines whether or not the buyer can take the quote to the checkout page.
        storeInfo:
          $ref: '#/components/schemas/storeInfo'
        companyInfo:
          $ref: '#/components/schemas/companyInfo'
        salesRepInfo:
          $ref: '#/components/schemas/salesRepInfo'
        extraFieldsInfo:
          $ref: '#/components/schemas/extraFieldsInfo'
        quoteLogo:
          $ref: '#/components/schemas/quoteLogo'
      title: quoteData_DETAIL
    Quotes_get-rfq-quote_id_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
        data:
          $ref: '#/components/schemas/quoteData_DETAIL'
      title: Quotes_get-rfq-quote_id_Response_200
    RfqQuoteIdGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
      title: RfqQuoteIdGetResponsesContentApplicationJsonSchemaData
    Get-rfq-quote_idRequestNotFoundError:
      type: object
      properties:
        code:
          type: integer
          default: '404'
          description: HTTP Response Code
        message:
          type: string
          default: Not Found Error
        data:
          $ref: '#/components/schemas/RfqQuoteIdGetResponsesContentApplicationJsonSchemaData'
      title: Get-rfq-quote_idRequestNotFoundError
    quoteData_PUT:
      type: object
      properties:
        storeHash:
          $ref: '#/components/schemas/storeHash'
        message:
          type: string
          description: A message sent to the sales rep via the in-quote messaging system.
      title: quoteData_PUT
    RfqQuoteIdPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
      title: RfqQuoteIdPutResponsesContentApplicationJsonSchemaData
    Quotes_put-rfq-quote_id_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
        data:
          $ref: '#/components/schemas/RfqQuoteIdPutResponsesContentApplicationJsonSchemaData'
      title: Quotes_put-rfq-quote_id_Response_200
    Put-rfq-quote_idRequestBadRequestError:
      type: object
      properties:
        code:
          type: integer
          default: '400'
          description: HTTP Response Code
        message:
          type: string
          default: Bad Requests Error
        data:
          $ref: '#/components/schemas/RfqQuoteIdPutResponsesContentApplicationJsonSchemaData'
      title: Put-rfq-quote_idRequestBadRequestError
    RfqQuoteIdCheckoutPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        checkoutUrl:
          type: string
          description: The URL that takes the quote to the storefront checkout page.
        cartId:
          type: string
          description: The unique identifier of the cart generated for the quote.
        cartUrl:
          type: string
          description: TThe URL that takes the quote to the storefront cart page.
      title: RfqQuoteIdCheckoutPostResponsesContentApplicationJsonSchemaData
    Quotes_post-rfq-quote_id-checkout_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
        data:
          $ref: '#/components/schemas/RfqQuoteIdCheckoutPostResponsesContentApplicationJsonSchemaData'
      title: Quotes_post-rfq-quote_id-checkout_Response_200
    responseNotFound:
      type: object
      properties:
        code:
          type: integer
          default: '404'
          description: HTTP Response Code
        message:
          type: string
          default: Not Found Error
      title: responseNotFound
    QuoteDataOrderedShippingMethodType:
      type: string
      enum:
        - custom
        - provider_methodtype
      description: >-
        The type of shipping method added to the quote. Custom shipping methods appear as `custom`, while static and
        real-time shipping methods appear as `provider_methodtype`, like `shipping_flatrate` or `usps_twodaydomestic`.
      title: QuoteDataOrderedShippingMethodType
    QuoteDataOrderedShippingMethod:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the shipping method.
        type:
          $ref: '#/components/schemas/QuoteDataOrderedShippingMethodType'
          description: >-
            The type of shipping method added to the quote. Custom shipping methods appear as `custom`, while static and
            real-time shipping methods appear as `provider_methodtype`, like `shipping_flatrate` or
            `usps_twodaydomestic`.
        description:
          type: string
          description: The name of the shipping method.
        imageUrl:
          type: string
          description: The URL of the logo image for the shipping provider, if the quote has a real-time shipping method.
        transitTime:
          type: string
          description: The estimated delivery time for a real-time shipping method.
        cost:
          type: number
          format: double
          description: The shipping rate on the quote.
        additionalDescription:
          type: string
          description: A secondary description found on some real-time shipping methods.
      description: Contains information on the quote's shipping method.
      title: QuoteDataOrderedShippingMethod
    quoteData_ORDERED:
      type: object
      properties:
        orderId:
          $ref: '#/components/schemas/orderId'
        storeHash:
          $ref: '#/components/schemas/storeHash'
        shippingTotal:
          type: number
          format: double
          description: The total cost of shipping on the quote.
        taxTotal:
          type: number
          format: double
          description: The tax value applied to the quote's total.
        shippingMethod:
          $ref: '#/components/schemas/QuoteDataOrderedShippingMethod'
          description: Contains information on the quote's shipping method.
      title: quoteData_ORDERED
    RfqQuoteIdOrderedPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      title: RfqQuoteIdOrderedPostResponsesContentApplicationJsonSchemaData
    Quotes_post-rfq-quote_id-ordered_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
        data:
          $ref: '#/components/schemas/RfqQuoteIdOrderedPostResponsesContentApplicationJsonSchemaData'
      title: Quotes_post-rfq-quote_id-ordered_Response_200
    Post-rfq-quote_id-orderedRequestBadRequestError:
      type: object
      properties:
        code:
          type: integer
          default: '400'
        message:
          type: string
          default: Quote has been ordered
        data:
          $ref: '#/components/schemas/RfqQuoteIdOrderedPostResponsesContentApplicationJsonSchemaData'
      title: Post-rfq-quote_id-orderedRequestBadRequestError
    RfqQuoteIdPdfExportPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        url:
          type: string
          description: The URL for the generated PDF that can be sent to the customer or attached to the quote.
      title: RfqQuoteIdPdfExportPostResponsesContentApplicationJsonSchemaData
    Quotes_post-rfq-quote_id-pdf-export_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
        data:
          $ref: '#/components/schemas/RfqQuoteIdPdfExportPostResponsesContentApplicationJsonSchemaData'
      title: Quotes_post-rfq-quote_id-pdf-export_Response_200
    RfqConfigsGetResponsesContentApplicationJsonSchemaDataSwitchStatusItems:
      type: object
      properties:
        key:
          type: string
          description: The internal key for the quote configuration.
        isEnabled:
          type: string
          description: >-
            Indicates whether or not a quote configuration is enabled in the store. `0` indicates disabled and `1`
            indicates enabled. For the `quote_logo` config, the enabled value is the logo image URL instead of `1`.
      title: RfqConfigsGetResponsesContentApplicationJsonSchemaDataSwitchStatusItems
    RfqConfigsGetResponsesContentApplicationJsonSchemaDataQuoteOtherConfigsItems:
      type: object
      properties:
        key:
          type: string
          description: The internal key for the quote configuration.
        value:
          type: string
          description: The text or number value specified for the setting.
      title: RfqConfigsGetResponsesContentApplicationJsonSchemaDataQuoteOtherConfigsItems
    RfqConfigsGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        switchStatus:
          type: array
          items:
            $ref: '#/components/schemas/RfqConfigsGetResponsesContentApplicationJsonSchemaDataSwitchStatusItems'
          description: Contains information about quotes settings that are either enabled or disabled.
        quoteOtherConfigs:
          type: array
          items:
            $ref: '#/components/schemas/RfqConfigsGetResponsesContentApplicationJsonSchemaDataQuoteOtherConfigsItems'
          description: Contains information about quotes settings with configurable text or number values.
      title: RfqConfigsGetResponsesContentApplicationJsonSchemaData
    Quotes_get-rfq-configs_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
        data:
          $ref: '#/components/schemas/RfqConfigsGetResponsesContentApplicationJsonSchemaData'
      title: Quotes_get-rfq-configs_Response_200
    email:
      type: string
      format: email
      description: The buyer's email address.
      title: email
    RfqEmailsPostRequestBodyContentApplicationJsonSchemaEmailTemplate:
      type: string
      enum:
        - Default with Checkout Button
        - Simple with Pictures
        - Waves with Pictures
        - Sky
        - Dots
        - Database with checkout button
        - Modern with checkout link
        - Modern without checkout link
      description: The template used to format the quote email.
      title: RfqEmailsPostRequestBodyContentApplicationJsonSchemaEmailTemplate
    RfqEmailsPostRequestBodyContentApplicationJsonSchemaEmailLang:
      type: string
      enum:
        - en
        - nl
        - de
        - fr
        - it
        - ja
        - zh
        - es
      description: The two-letter code for the language of the quote email and PDF, if included.
      title: RfqEmailsPostRequestBodyContentApplicationJsonSchemaEmailLang
    responseSuccess:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
        data:
          $ref: '#/components/schemas/ResponseSuccessData'
      title: responseSuccess
    RfqEmailsPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      title: RfqEmailsPostResponsesContentApplicationJsonSchemaData
    Post-rfq-emailsRequestBadRequestError:
      type: object
      properties:
        code:
          type: integer
          default: '400'
        message:
          type: string
          default: Invalid email address
        data:
          $ref: '#/components/schemas/RfqEmailsPostResponsesContentApplicationJsonSchemaData'
      title: Post-rfq-emailsRequestBadRequestError
    RfqStoreInfoGetResponsesContentApplicationJsonSchemaDataStoreUserInfo:
      type: object
      properties:
        storeInfo:
          $ref: '#/components/schemas/storeInfo'
        companyInfo:
          $ref: '#/components/schemas/companyInfo'
        salesRepInfo:
          $ref: '#/components/schemas/salesRepInfo'
        extraFieldsInfo:
          $ref: '#/components/schemas/extraFieldsInfo'
        quoteLogo:
          $ref: '#/components/schemas/quoteLogo'
      title: RfqStoreInfoGetResponsesContentApplicationJsonSchemaDataStoreUserInfo
    RfqStoreInfoGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        storeUserInfo:
          $ref: '#/components/schemas/RfqStoreInfoGetResponsesContentApplicationJsonSchemaDataStoreUserInfo'
      title: RfqStoreInfoGetResponsesContentApplicationJsonSchemaData
    Quotes_get-rfq-store-info_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP Response Code
        message:
          type: string
          default: SUCCESS
        data:
          $ref: '#/components/schemas/RfqStoreInfoGetResponsesContentApplicationJsonSchemaData'
      title: Quotes_get-rfq-store-info_Response_200
    SalesRepsSuperAdminIdCompaniesGetParametersOrderBy:
      type: string
      enum:
        - companyName
        - companyAdminName
        - companyEmail
      title: SalesRepsSuperAdminIdCompaniesGetParametersOrderBy
    SalesRepsSuperAdminIdCompaniesGetParametersSortBy:
      type: string
      enum:
        - DESC
        - ASC
      default: DESC
      title: SalesRepsSuperAdminIdCompaniesGetParametersSortBy
    SalesRepsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaDataListItemsExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
          description: The name of the extra field.
        fieldValue:
          type: string
          description: The value of the extra field.
      title: SalesRepsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaDataListItemsExtraFieldsItems
    SalesRepsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaDataListItems:
      type: object
      properties:
        companyName:
          type: string
          description: The name of the business associated with the Company account.
        companyId:
          type: string
          description: Unique numeric ID of the Company account. This is a **read-only** field.
        extraFields:
          type: array
          items:
            $ref: >-
              #/components/schemas/SalesRepsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaDataListItemsExtraFieldsItems
        bcGroupName:
          type: string
          description: >-
            The BigCommerce customer group associated with the Company. If [Independent Company
            behavior](https://support.bigcommerce.com/s/article/Companies-and-Customer-Groups) is enabled, this field is
            not used.
        companyAdminName:
          type: string
          description: The name of the primary admin user for the Company.
        companyEmail:
          type: string
          format: email
          description: The email address of the primary admin user for the Company.
      title: SalesRepsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaDataListItems
    SalesRepsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/SalesRepsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaDataListItems'
      title: SalesRepsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaData
    SalesRepsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaPagination:
      type: object
      properties:
        totalCount:
          type: integer
          description: The total number of items in the results.
        perCount:
          type: integer
          description: The total number of items matching the search query.
        offset:
          type: integer
          default: 0
          description: The starting offset for the current page of the response.
        limit:
          type: integer
          description: The maximum number of items allowed per page of the response.
      title: SalesRepsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaPagination
    Super Admin_get-sales-reps-salesRepId-companies_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: The HTTP Status code of the response.
        message:
          type: string
          default: SUCCESS
          description: Response message.
        data:
          $ref: '#/components/schemas/SalesRepsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaData'
        pagination:
          $ref: '#/components/schemas/SalesRepsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaPagination'
      title: Super Admin_get-sales-reps-salesRepId-companies_Response_200
    SalesRepsSuperAdminIdCompaniesMasqueradingGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      title: SalesRepsSuperAdminIdCompaniesMasqueradingGetResponsesContentApplicationJsonSchemaData
    Super Admin_get-sales-reps-customerId-companies-masquerading_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: The HTTP Status code of the response.
        message:
          type: string
          default: SUCCESS
          description: Response message.
        data:
          $ref: '#/components/schemas/SalesRepsSuperAdminIdCompaniesMasqueradingGetResponsesContentApplicationJsonSchemaData'
      title: Super Admin_get-sales-reps-customerId-companies-masquerading_Response_200
    SalesRepsSuperAdminIdCompaniesCompanyIdBeginMasqPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        email:
          type: string
          format: email
          description: The email address associated with the Super Admin account.
        firstName:
          type: string
          description: The first name associated with the Super Admin account in B2B Edition.
        lastName:
          type: string
          description: The last name associated with the Super Admin account in B2B Edition.
        phoneNumber:
          type: string
          description: The phone number associated with the Super Admin account in B2B Edition.
      title: SalesRepsSuperAdminIdCompaniesCompanyIdBeginMasqPutResponsesContentApplicationJsonSchemaData
    Super Admin_put-sales-reps-customerId-companies-companyId-begin-masq_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: The HTTP Status code of the response.
        message:
          type: string
          default: SUCCESS
          description: Response message.
        data:
          $ref: >-
            #/components/schemas/SalesRepsSuperAdminIdCompaniesCompanyIdBeginMasqPutResponsesContentApplicationJsonSchemaData
      title: Super Admin_put-sales-reps-customerId-companies-companyId-begin-masq_Response_200
    SalesRepsSuperAdminIdCompaniesCompanyIdEndMasqPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      title: SalesRepsSuperAdminIdCompaniesCompanyIdEndMasqPutResponsesContentApplicationJsonSchemaData
    Super Admin_put-sales-reps-customerId-companies-companyId-end-masq_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: The HTTP Status code of the response.
        message:
          type: string
          default: SUCCESS
          description: Response message.
        data:
          $ref: >-
            #/components/schemas/SalesRepsSuperAdminIdCompaniesCompanyIdEndMasqPutResponsesContentApplicationJsonSchemaData
      title: Super Admin_put-sales-reps-customerId-companies-companyId-end-masq_Response_200
    ShoppinglistsGetResponsesContentApplicationJsonSchemaDataListItemsCustomerInfo:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        userId:
          type: number
          format: double
        email:
          type: string
      required:
        - firstName
        - lastName
        - userId
        - email
      title: ShoppinglistsGetResponsesContentApplicationJsonSchemaDataListItemsCustomerInfo
    ShoppinglistsGetResponsesContentApplicationJsonSchemaDataListItems:
      type: object
      properties:
        id:
          type: number
          format: double
        name:
          type: string
        status:
          type: number
          format: double
          description: |-
            0:   Approved
            20:  Deleted
            30:  Draft
            40:  Ready for approval
        description:
          type: string
        updatedAt:
          type: number
          format: double
        createdAt:
          type: number
          format: double
        totalCount:
          type: number
          format: double
          description: Total count of shopping list items
        customerInfo:
          $ref: '#/components/schemas/ShoppinglistsGetResponsesContentApplicationJsonSchemaDataListItemsCustomerInfo'
      required:
        - id
        - name
        - status
        - description
        - updatedAt
        - createdAt
        - totalCount
      title: ShoppinglistsGetResponsesContentApplicationJsonSchemaDataListItems
    ShoppinglistsGetResponsesContentApplicationJsonSchemaDataPagination:
      type: object
      properties:
        totalCount:
          type: number
          format: double
        offset:
          type: number
          format: double
        limit:
          type: number
          format: double
      required:
        - totalCount
        - offset
        - limit
      title: ShoppinglistsGetResponsesContentApplicationJsonSchemaDataPagination
    ShoppinglistsGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/ShoppinglistsGetResponsesContentApplicationJsonSchemaDataListItems'
        pagination:
          $ref: '#/components/schemas/ShoppinglistsGetResponsesContentApplicationJsonSchemaDataPagination'
      required:
        - list
        - pagination
      title: ShoppinglistsGetResponsesContentApplicationJsonSchemaData
    Shopping List_get-shoppinglists_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
        message:
          type: string
        data:
          $ref: '#/components/schemas/ShoppinglistsGetResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Shopping List_get-shoppinglists_Response_200
    ShoppinglistsPostRequestBodyContentApplicationJsonSchemaStatus:
      type: string
      enum:
        - '0'
        - '20'
        - '30'
        - '40'
      description: |-
        0:   Approved
        20:  Deleted
        30:  Draft
        40:  Ready for approval
      title: ShoppinglistsPostRequestBodyContentApplicationJsonSchemaStatus
    ShoppinglistsPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        shopplistId:
          type: number
          format: double
      required:
        - shopplistId
      title: ShoppinglistsPostResponsesContentApplicationJsonSchemaData
    Shopping List_post-shoppinglists_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
        message:
          type: string
        data:
          $ref: '#/components/schemas/ShoppinglistsPostResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Shopping List_post-shoppinglists_Response_200
    ShoppinglistsPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        shoplistId:
          type: number
          format: double
      title: ShoppinglistsPutResponsesContentApplicationJsonSchemaData
    Shopping List_put-shoppinglists_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
        message:
          type: string
        data:
          $ref: '#/components/schemas/ShoppinglistsPutResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Shopping List_put-shoppinglists_Response_200
    ShoppinglistsListsGetResponsesContentApplicationJsonSchemaDataListItems:
      type: object
      properties:
        id:
          type: number
          format: double
        name:
          type: string
      required:
        - id
        - name
      title: ShoppinglistsListsGetResponsesContentApplicationJsonSchemaDataListItems
    ShoppinglistsListsGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/ShoppinglistsListsGetResponsesContentApplicationJsonSchemaDataListItems'
      required:
        - list
      title: ShoppinglistsListsGetResponsesContentApplicationJsonSchemaData
    Shopping List_get-shoppinglists-lists_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
        message:
          type: string
        data:
          $ref: '#/components/schemas/ShoppinglistsListsGetResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Shopping List_get-shoppinglists-lists_Response_200
    ShoppinglistsItemsPostRequestBodyContentApplicationJsonSchemaItemsItemsOptionListItems:
      type: object
      properties:
        option_id:
          type: string
        option_value:
          type: string
      required:
        - option_id
        - option_value
      title: ShoppinglistsItemsPostRequestBodyContentApplicationJsonSchemaItemsItemsOptionListItems
    ShoppinglistsItemsPostRequestBodyContentApplicationJsonSchemaItemsItems:
      type: object
      properties:
        productId:
          type: string
        variantId:
          type: string
        qty:
          type: string
        optionList:
          type: array
          items:
            $ref: >-
              #/components/schemas/ShoppinglistsItemsPostRequestBodyContentApplicationJsonSchemaItemsItemsOptionListItems
        sortOrder:
          type: integer
          description: The sort order for item
      required:
        - productId
        - variantId
        - qty
      title: ShoppinglistsItemsPostRequestBodyContentApplicationJsonSchemaItemsItems
    ShoppinglistsItemsPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      title: ShoppinglistsItemsPostResponsesContentApplicationJsonSchemaData
    Shopping List_post-shoppinglists-items_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
        message:
          type: string
        data:
          $ref: '#/components/schemas/ShoppinglistsItemsPostResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Shopping List_post-shoppinglists-items_Response_200
    ShoppinglistsItemsPutRequestBodyContentApplicationJsonSchemaOptionListItems:
      type: object
      properties:
        option_id:
          type: string
        option_value:
          type: string
      required:
        - option_id
        - option_value
      title: ShoppinglistsItemsPutRequestBodyContentApplicationJsonSchemaOptionListItems
    ShoppinglistsItemsPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      title: ShoppinglistsItemsPutResponsesContentApplicationJsonSchemaData
    Shopping List_put-shoppinglists-items_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
        message:
          type: string
        data:
          $ref: '#/components/schemas/ShoppinglistsItemsPutResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Shopping List_put-shoppinglists-items_Response_200
    ShoppinglistsItemsExtensionGetParametersSortBy:
      type: string
      enum:
        - product_name
        - quantity
        - product_sku
        - updated_at
        - created_at
        - sort_order
      title: ShoppinglistsItemsExtensionGetParametersSortBy
    ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItemsOptionsListItems:
      type: object
      properties:
        option_id:
          type: string
        option_value:
          type: string
      required:
        - option_id
        - option_value
      title: ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItemsOptionsListItems
    ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItemsPrimaryImage:
      type: object
      properties:
        urlThumbnail:
          type: string
      required:
        - urlThumbnail
      title: ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItemsPrimaryImage
    ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItems:
      type: object
      properties:
        itemId:
          type: number
          format: double
          description: Shopping list item ID
        productId:
          type: string
          description: 'Product ID '
        baseSku:
          type: string
          description: Product base SKU
        variantSku:
          type: string
          description: SKU name
        qty:
          type: number
          format: double
          description: Qty number
        basePrice:
          type: number
          format: double
        productUrl:
          type: string
        optionsList:
          type: array
          items:
            $ref: >-
              #/components/schemas/ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItemsOptionsListItems
        variantId:
          type: string
          description: Variant SKU ID
        primaryImage:
          $ref: >-
            #/components/schemas/ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItemsPrimaryImage
        productName:
          type: string
          description: Product name
        updatedAt:
          type: number
          format: double
        createdAt:
          type: number
          format: double
        sortOrder:
          type: integer
          description: The sort order for item
      required:
        - itemId
        - productId
        - baseSku
        - variantSku
        - qty
        - basePrice
        - productUrl
        - variantId
        - productName
        - updatedAt
        - createdAt
      title: ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItems
    ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataCustomerInfo:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
      required:
        - firstName
        - lastName
      title: ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataCustomerInfo
    ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataPagination:
      type: object
      properties:
        totalCount:
          type: number
          format: double
        offset:
          type: number
          format: double
        limit:
          type: number
          format: double
      required:
        - totalCount
        - offset
        - limit
      title: ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataPagination
    ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        name:
          type: string
          description: Shopping list name
        description:
          type: string
          description: Description of shopping list
        status:
          type: number
          format: double
        isOwner:
          type: string
          description: If owner of shopping list
        products:
          type: array
          items:
            $ref: '#/components/schemas/ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataProductsItems'
        customerInfo:
          $ref: '#/components/schemas/ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataCustomerInfo'
        grandTotal:
          type: number
          format: double
        channelId:
          type: integer
          description: B2B Edition channel ID
        channelName:
          type: string
          description: Store Channel name
        pagination:
          $ref: '#/components/schemas/ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaDataPagination'
      required:
        - name
        - description
        - status
        - isOwner
        - products
        - customerInfo
        - grandTotal
        - pagination
      title: ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaData
    Shopping List_get-shoppinglists-items-extension_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
        message:
          type: string
        data:
          $ref: '#/components/schemas/ShoppinglistsItemsExtensionGetResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Shopping List_get-shoppinglists-items-extension_Response_200
    ShoppinglistsShoppingListIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      title: ShoppinglistsShoppingListIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaData
    Shopping List_delete-shoppinglists-shoppingListId-items-itemId_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
        message:
          type: string
        data:
          $ref: '#/components/schemas/ShoppinglistsShoppingListIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Shopping List_delete-shoppinglists-shoppingListId-items-itemId_Response_200
    ShoppinglistsShoppingListIdDeleteResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      title: ShoppinglistsShoppingListIdDeleteResponsesContentApplicationJsonSchemaData
    Shopping List_delete-shoppinglists-shoppingListId_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
        message:
          type: string
        data:
          $ref: '#/components/schemas/ShoppinglistsShoppingListIdDeleteResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Shopping List_delete-shoppinglists-shoppingListId_Response_200
    ShoppinglistsDuplicatePostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        shoppingListId:
          type: string
      required:
        - shoppingListId
      title: ShoppinglistsDuplicatePostResponsesContentApplicationJsonSchemaData
    Shopping List_post-shoppinglists-duplicate_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
        message:
          type: string
        data:
          $ref: '#/components/schemas/ShoppinglistsDuplicatePostResponsesContentApplicationJsonSchemaData'
      required:
        - code
        - message
        - data
      title: Shopping List_post-shoppinglists-duplicate_Response_200
    StoresCurrenciesGetResponsesContentApplicationJsonSchemaDataCurrenciesItemsTokenLocation:
      type: string
      enum:
        - left
        - right
      description: Determines whether the currency symbol is added to the left or the right of pricing.
      title: StoresCurrenciesGetResponsesContentApplicationJsonSchemaDataCurrenciesItemsTokenLocation
    StoresCurrenciesGetResponsesContentApplicationJsonSchemaDataCurrenciesItems:
      type: object
      properties:
        id:
          type: number
          format: double
          description: The unique ID for the currency within the BigCommerce store.
        is_default:
          type: boolean
          description: Indicates whether the currency is set as the default for the store.
        country_iso2:
          type: string
          description: The two-character ISO country code for the currency.
        last_updated:
          type: string
          description: The date and time of the most recent update to the currency's settings.
        default_for_country_codes:
          type: array
          items:
            type: string
          description: The list of two-character ISO country codes for which the currency is the default.
        currency_code:
          type: string
          description: The three-letter code corresponding to the currency.
        currency_exchange_rate:
          type: string
          description: The exchange rate between your store’s default currency and the selected currency.
        name:
          type: string
          description: The display name of the currency as shown on the storefront.
        token:
          type: string
          description: The currency symbol.
        auto_update:
          type: boolean
          description: >-
            Indicates whether the exchange rate is set to automatically update. The store's default currency will always
            return `false`.
        token_location:
          $ref: >-
            #/components/schemas/StoresCurrenciesGetResponsesContentApplicationJsonSchemaDataCurrenciesItemsTokenLocation
          description: Determines whether the currency symbol is added to the left or the right of pricing.
        decimal_token:
          type: string
          description: The character used to separate decimal values in pricing.
        thousands_token:
          type: string
          description: The character used to separate the hundredths and thousandths places in pricing.
        decimal_places:
          type: number
          format: double
          description: The number of digits to display after the decimal.
        enabled:
          type: boolean
          description: Indicates whether the currency is currently visible on the storefront.
        is_transactional:
          type: boolean
          description: >-
            Indicates whether the currency is transacting (`true`) or display (`false`). For more information see
            [Managing Currencies (Help Center)](https://support.bigcommerce.com/s/article/Managing-Currencies).
      title: StoresCurrenciesGetResponsesContentApplicationJsonSchemaDataCurrenciesItems
    StoresCurrenciesGetResponsesContentApplicationJsonSchemaDataChannelCurrencies:
      type: object
      properties: {}
      description: >-
        The list of currencies enabled on a specific channel. If the `channelId` parameter is **not** provided, this
        will return an empty object `{}`.
      title: StoresCurrenciesGetResponsesContentApplicationJsonSchemaDataChannelCurrencies
    StoresCurrenciesGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        currencies:
          type: array
          items:
            $ref: '#/components/schemas/StoresCurrenciesGetResponsesContentApplicationJsonSchemaDataCurrenciesItems'
        channelCurrencies:
          $ref: '#/components/schemas/StoresCurrenciesGetResponsesContentApplicationJsonSchemaDataChannelCurrencies'
          description: >-
            The list of currencies enabled on a specific channel. If the `channelId` parameter is **not** provided, this
            will return an empty object `{}`.
        entered_inclusive_tax:
          type: boolean
          description: >-
            Indicates whether product prices were provided inclusive of sales tax. For more information, see [Tax
            Overview (Help Center)](https://support.bigcommerce.com/s/article/Tax-Overview).
      description: Data associated with the response.
      title: StoresCurrenciesGetResponsesContentApplicationJsonSchemaData
    Store Settings_get-stores-currencies_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP response code for the request.
        message:
          type: string
          default: SUCCESS
          description: Message indicating the status of the request.
        data:
          $ref: '#/components/schemas/StoresCurrenciesGetResponsesContentApplicationJsonSchemaData'
          description: Data associated with the response.
      description: Response body for the request.
      title: Store Settings_get-stores-currencies_Response_200
    Get-stores-currenciesRequestBadRequestError:
      type: object
      properties:
        code:
          type: integer
          default: 400
          description: HTTP response code for the request.
        message:
          type: string
          default: bad request
          description: Message indicating the status of the request.
      description: Response body for the request.
      title: Get-stores-currenciesRequestBadRequestError
    StoresOrderStatusesGetResponsesContentApplicationJsonSchemaDataOrderStatusesItems:
      type: object
      properties:
        systemLabel:
          type: string
          description: >-
            The default name of the order status in BigCommerce. This label is directly connected to the behavior of the
            label during order management.
        customLabel:
          type: string
          description: >-
            The custom name of the order status in BigCommerce. If the status is unedited, then this will match
            `systemLabel`.
        statusCode:
          type: string
          description: The unique numeric code associated with the order status.
      title: StoresOrderStatusesGetResponsesContentApplicationJsonSchemaDataOrderStatusesItems
    StoresOrderStatusesGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        orderStatuses:
          type: array
          items:
            $ref: '#/components/schemas/StoresOrderStatusesGetResponsesContentApplicationJsonSchemaDataOrderStatusesItems'
          description: >-
            The complete list of order statuses available along with their status code and store-specific custom label.
            For more information, see [Order
            Status](/developer/api-reference/rest/admin/management/orders/order-status).
      description: Data associated with the response.
      title: StoresOrderStatusesGetResponsesContentApplicationJsonSchemaData
    Store Settings_get-stores-order-statuses_Response_200:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP response code for the request.
        message:
          type: string
          default: SUCCESS
          description: Message indicating the status of the request.
        data:
          $ref: '#/components/schemas/StoresOrderStatusesGetResponsesContentApplicationJsonSchemaData'
          description: Data associated with the response.
      description: Response body for the request.
      title: Store Settings_get-stores-order-statuses_Response_200
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      description: >-
        ### Authentication header

        | Header | Argument | Description |

        |:-------|:---------|:------------|

        |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the [REST
        Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api) section[...]
