openapi: 3.1.0
info:
  title: 'Archived B2B Edition: V2'
  version: 1.0.0
paths:
  /addresses/country_state:
    get:
      operationId: addresses_country_state_list
      summary: Convert Country State
      description: Convert country/state name to their code or code to name
      tags:
        - address
      parameters:
        - name: country
          in: query
          description: Country code/name
          required: false
          schema:
            type: string
        - name: state
          in: query
          description: Country code/name
          required: false
          schema:
            type: string
        - name: search_type
          in: query
          description: >-
            Convert type, code means transfer the input country/state name to their code, name means transfer the input
            country/state code to their name
          required: false
          schema:
            $ref: '#/components/schemas/AddressesCountryStateGetParametersSearchType'
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address_addresses_country_state_list_Response_200'
        '404':
          description: Response record not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Addresses_country_state_listRequestNotFoundError'
  /companies/{companyId}/addresses:
    get:
      operationId: companies_addresses_list
      summary: Get Company Addresses
      description: Get all addresses for a company
      tags:
        - address
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: minLastModifiedTime
          in: query
          description: 'Company filter condition: timestamp string e.g. 01/01/2000'
          required: false
          schema:
            type: number
            format: double
        - name: maxLastModifiedTime
          in: query
          description: 'Company filter condition: timestamp string e.g. 01/01/2000'
          required: false
          schema:
            type: number
            format: double
        - name: minLastCreatedTime
          in: query
          description: 'Company filter condition: timestamp string e.g. 01/01/2000'
          required: false
          schema:
            type: number
            format: double
        - name: maxLastCreatedTime
          in: query
          description: 'Company filter condition: timestamp string e.g. 01/01/2000'
          required: false
          schema:
            type: number
            format: double
        - name: q
          in: query
          description: Company query string
          required: false
          schema:
            type: string
        - name: firstName
          in: query
          description: Address first name filter
          required: false
          schema:
            type: number
            format: double
        - name: lastName
          in: query
          description: Address first name filter
          required: false
          schema:
            type: number
            format: double
        - name: address
          in: query
          description: Address line 1 filter
          required: false
          schema:
            type: number
            format: double
        - name: city
          in: query
          description: Address city filter
          required: false
          schema:
            type: number
            format: double
        - name: country
          in: query
          description: Address country filter
          required: false
          schema:
            type: number
            format: double
        - name: state
          in: query
          description: Address state filter
          required: false
          schema:
            type: number
            format: double
        - name: zipCode
          in: query
          description: Address zip code filter
          required: false
          schema:
            type: number
            format: double
        - name: phoneNumber
          in: query
          description: Address phone number filter
          required: false
          schema:
            type: number
            format: double
        - name: isShipping
          in: query
          description: Address is shipping filter
          required: false
          schema:
            type: number
            format: double
        - name: isBilling
          in: query
          description: Address is billing filter
          required: false
          schema:
            type: number
            format: double
        - name: externalId[]
          in: query
          description: Address external id filter
          required: false
          schema:
            type: array
            items:
              description: Any type
        - name: offset
          in: query
          description: Address pagination offset, default 0
          required: false
          schema:
            type: number
            format: double
        - name: limit
          in: query
          description: 'Address pagination limit, default 4. '
          required: false
          schema:
            type: number
            format: double
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address_companies_addresses_list_Response_200'
    post:
      operationId: companies_addresses_create
      summary: Create A Company Address
      description: >-
        Creates a new address for a company. You will specify the address fields and the type of address. The address
        can be billing, shipping, or both. You can also request that this address becomes the new default billing or
        shipping address for the company.
      tags:
        - address
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address_companies_addresses_create_Response_200'
        '422':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_addresses_createRequestUnprocessableEntityError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                addressLine1:
                  type: string
                  description: Typically the street address
                addressLine2:
                  type: string
                  description: More detailed information about where to deliver mail, such as a suite or office number
                city:
                  type: string
                country:
                  $ref: '#/components/schemas/CompaniesCompanyIdAddressesPostRequestBodyContentApplicationJsonSchemaCountry'
                firstName:
                  type: string
                  description: Address first name
                isBilling:
                  type: boolean
                  description: Indicates whether the address is a billing address
                isDefaultBilling:
                  type: boolean
                  description: Indicates whether the address is the default billing address
                isDefaultShipping:
                  type: boolean
                  description: Indicates whether the address is the default shipping address
                isShipping:
                  type: boolean
                  description: Indicates whether the address is a shipping address
                label:
                  type: string
                  description: Address label
                lastName:
                  type: string
                  description: Address last name
                phoneNumber:
                  type: string
                  description: Address phone number
                state:
                  $ref: '#/components/schemas/CompaniesCompanyIdAddressesPostRequestBodyContentApplicationJsonSchemaState'
                zipCode:
                  type: string
                externalId:
                  type: string
              required:
                - addressLine1
                - city
                - country
                - firstName
                - lastName
                - state
                - zipCode
  /companies/{companyId}/addresses/{addressId}:
    get:
      operationId: companies_addresses_read
      summary: Get A Company Address
      description: Get an address for a company
      tags:
        - address
      parameters:
        - name: addressId
          in: path
          required: true
          schema:
            type: string
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address_companies_addresses_read_Response_200'
        '404':
          description: Response record not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_addresses_readRequestNotFoundError'
    put:
      operationId: companies_addresses_update
      summary: Update A Company Address
      description: >-
        Updates an address for a company. You can change whether the address is for billing, shipping, or both. You can
        also update the address to be the default billing or shipping address for the company.
      tags:
        - address
      parameters:
        - name: addressId
          in: path
          required: true
          schema:
            type: string
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address_companies_addresses_update_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_addresses_updateRequestBadRequestError'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_addresses_updateRequestNotFoundError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                addressLine1:
                  type: string
                  description: Typically the street address
                addressLine2:
                  type: string
                  description: More detailed information about where to deliver mail, such as a suite or office number
                city:
                  type: string
                country:
                  $ref: >-
                    #/components/schemas/CompaniesCompanyIdAddressesAddressIdPutRequestBodyContentApplicationJsonSchemaCountry
                firstName:
                  type: string
                  description: Address first name
                isBilling:
                  type: boolean
                  description: Indicates whether the address is a billing address
                isDefaultBilling:
                  type: boolean
                  description: Indicates whether the address is the default billing address
                isDefaultShipping:
                  type: boolean
                  description: Indicates whether the address is the default shipping address
                isShipping:
                  type: boolean
                  description: Indicates whether the address is a shipping address
                label:
                  type: string
                  description: Address label
                lastName:
                  type: string
                  description: Address last name
                phoneNumber:
                  type: string
                  description: Address phone number
                state:
                  $ref: >-
                    #/components/schemas/CompaniesCompanyIdAddressesAddressIdPutRequestBodyContentApplicationJsonSchemaState
                zipCode:
                  type: string
                externalId:
                  type: string
    delete:
      operationId: companies_addresses_delete
      summary: Delete A Company Address
      description: Deletes an address from a company.
      tags:
        - address
      parameters:
        - name: addressId
          in: path
          required: true
          schema:
            type: string
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Deleted successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address_companies_addresses_delete_Response_200'
        '404':
          description: Company not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_addresses_deleteRequestNotFoundError'
  /companies/convert-from-customer-group:
    post:
      operationId: companies_convert-from-customer-group_create
      summary: Create Company From CG
      description: Create company from bigCommerce customer group. This API only enable for non-MSF store.
      tags:
        - company
      parameters:
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company_companies_convert-from-customer-group_create_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_convert-from-customer-group_createRequestBadRequestError'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_convert-from-customer-group_createRequestNotFoundError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                acceptWelcomeEmail:
                  $ref: >-
                    #/components/schemas/CompaniesConvertFromCustomerGroupPostRequestBodyContentApplicationJsonSchemaAcceptWelcomeEmail
                  description: (0=will not receive email 1=will receive email)
                addressLine1:
                  type: string
                  description: Address string line 1
                addressLine2:
                  type: string
                  description: Address string line 2
                adminEmail:
                  type: string
                  description: Company admin user email
                adminFirstName:
                  type: string
                  description: Company admin user's first name
                adminLastName:
                  type: string
                  description: Company admin user's last name
                adminPhoneNumber:
                  type: string
                  description: Company admin user phone number
                city:
                  type: string
                companyEmail:
                  type: string
                companyName:
                  type: string
                country:
                  type: string
                customerGroupId:
                  type: string
                  description: BC customer group ID
                extraFields:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CompaniesConvertFromCustomerGroupPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems
                  description: >-
                    To use customized extra fields with field names you need to first add company extra fields in
                    Settings > Extra fields inside B2B edition. eg. If you want to create a new company with an extra
                    integer field named licenseNO, you can use this structure [{'fieldName': 'LicenseNO', 'fieldValue':
                    10342340323}] in the request body.
                phoneNumber:
                  type: string
                state:
                  type: string
                zipCode:
                  type: string
                userExtraFields:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CompaniesConvertFromCustomerGroupPostRequestBodyContentApplicationJsonSchemaUserExtraFieldsItems
              required:
                - adminEmail
                - adminFirstName
                - adminLastName
                - companyEmail
                - companyName
                - customerGroupId
                - phoneNumber
  /companies/{companyId}/basic-info:
    get:
      operationId: companies_basic-info_list
      summary: Get Company Basic Information
      description: Get company's basic information
      tags:
        - company
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company_companies_basic-info_list_Response_200'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_basic-info_listRequestNotFoundError'
    put:
      operationId: companies_basic-info_update
      summary: Update Company Basic Information
      description: Update a company's basic info, you can update on or more options
      tags:
        - company
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company_companies_basic-info_update_Response_200'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_basic-info_updateRequestNotFoundError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                addressLine1:
                  type: string
                  description: Address string line 1
                addressLine2:
                  type: string
                  description: Address string line 2
                catalogId:
                  type: string
                  description: BigCommerce price list Id that company related(If put its 0 will clear the catalog).
                city:
                  type: string
                companyEmail:
                  type: string
                companyName:
                  type: string
                companyStatus:
                  type: string
                  description: |-
                    Company status: 

                     0=PENDING 1=APPROVED 2=REJECTED 3=INACTIVE 4=DELETED
                country:
                  type: string
                  description: |

                    Country full name or ISO2 country code. For Example: 

                    A Country full name: Afghanistan 

                    ISO2 Country code: AF
                description:
                  type: string
                extraFields:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CompaniesCompanyIdBasicInfoPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems
                  description: >-
                    To use customized extra fields with field names you need to first add company extra fields in
                    Settings > Extra fields inside B2B edition. eg. If you want to create a new company with an extra
                    integer field named licenseNO, you can use this structure [{'fieldName': 'LicenseNO', 'fieldValue':
                    10342340323}] in the request body.
                phoneNumber:
                  type: string
                state:
                  type: string
                zipCode:
                  type: string
                priceListAssign:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CompaniesCompanyIdBasicInfoPutRequestBodyContentApplicationJsonSchemaPriceListAssignItems
  /companies/{companyId}/force-del:
    delete:
      operationId: companies_force-del_delete
      summary: Delete Company With Related
      description: Force Delete A Company and its Related Information.
      tags:
        - company
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Deleted successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company_companies_force-del_delete_Response_200'
        '404':
          description: Company not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_force-del_deleteRequestNotFoundError'
  /companies/{companyId}/orderBCIds:
    get:
      operationId: companies_orderBCIds_list
      summary: Get BC Order Id List By Company Id
      description: Get bC order ID list by company id
      tags:
        - company
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: offset
          in: query
          description: 'Pagination offset default: 0'
          required: false
          schema:
            type: number
            format: double
        - name: limit
          in: query
          description: 'Pagination limit default: 10'
          required: false
          schema:
            type: number
            format: double
        - name: beginDateAt
          in: query
          description: End date filter, in format '12/31/2019'
          required: false
          schema:
            type: string
        - name: endDateAt
          in: query
          description: End date filter, in format '12/31/2019'
          required: false
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company_companies_orderBCIds_list_Response_200'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_orderBCIds_listRequestNotFoundError'
  /users/{customerId}/companies:
    get:
      operationId: users_companies_list
      summary: Get Company By CustomerId
      description: Get company by customer Id, if company not in bigCommerce will delete the company
      tags:
        - company
      parameters:
        - name: customerId
          in: path
          description: BigCommerce's customer id
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company_users_companies_list_Response_200'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users_companies_listRequestNotFoundError'
  /companies/users/{customerId}/orders:
    post:
      operationId: companies_users_orders_create
      summary: Create Order Without CompanyID
      description: Create an order from bigCommerce, you must known order id
      tags:
        - order
      parameters:
        - name: customerId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order_companies_users_orders_create_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_users_orders_createRequestBadRequestError'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_users_orders_createRequestNotFoundError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                orderId:
                  type: string
                  description: BigCommerce order id
                poNumber:
                  type: string
                  description: PoNumber
                totalIncTax:
                  type: number
                  format: double
                  description: Total incTax
              required:
                - orderId
                - totalIncTax
  /companies/{companyId}/orders:
    get:
      operationId: companies_orders_list
      summary: Get Company Orders
      description: Get company all orders, with pagination data
      tags:
        - order
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: offset
          in: query
          description: 'Pagination offset default: 0'
          required: false
          schema:
            type: number
            format: double
        - name: limit
          in: query
          description: 'Pagination limit default: 10'
          required: false
          schema:
            type: number
            format: double
        - name: orderBy
          in: query
          description: in ['bcOrderId', 'totalIncTax', 'createdAt']
          required: false
          schema:
            type: string
        - name: beginDateAt
          in: query
          description: End date filter, in format '12/31/2019'
          required: false
          schema:
            type: string
        - name: endDateAt
          in: query
          description: End date filter, in format '12/31/2019'
          required: false
          schema:
            type: string
        - name: includeExtra
          in: query
          description: 'Switch show extra fields, allow: 0, 1'
          required: false
          schema:
            type: string
        - name: channelId
          in: query
          description: BigCommerce channel id
          required: false
          schema:
            type: number
            format: double
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order_companies_orders_list_Response_200'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_orders_listRequestNotFoundError'
  /companies/{companyId}/user/{customerId}/orders:
    post:
      operationId: companies_user_orders_create
      summary: Create An Order
      description: Create an order from bigCommerce, you must known order id
      tags:
        - order
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: customerId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order_companies_user_orders_create_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_user_orders_createRequestBadRequestError'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_user_orders_createRequestNotFoundError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                orderId:
                  type: string
                  description: BigCommerce order id
                poNumber:
                  type: string
                  description: PoNumber
                totalIncTax:
                  type: number
                  format: double
                  description: Total incTax
              required:
                - orderId
                - totalIncTax
  /orders:
    put:
      operationId: orders_update
      summary: Update Company Order With BC OrderId
      description: |-
        Update order, billingAddress and products cannot be omitted. products can be two format. 
         1. Product with variants. 
         2. Base product
      tags:
        - order
      parameters:
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order_orders_update_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_updateRequestBadRequestError'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_updateRequestNotFoundError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                baseHandlingCost:
                  type: string
                  description: The value of the base handling cost. (Float, Float-As-String, Integer).
                baseShippingCost:
                  type: string
                  description: The value of the base shipping cost. (Float, Float-As-String, Integer)
                baseWrappingCost:
                  type: string
                  description: The value of the base wrapping cost. (Float, Float-As-String, Integer).
                billingAddress:
                  $ref: '#/components/schemas/OrdersPutRequestBodyContentApplicationJsonSchemaBillingAddress'
                channelId:
                  type: string
                  description: BigCommerce channel id. Shows where the order originated. The channel_id will default to 1.
                creditCardType:
                  type: string
                  description: Credit card type.
                customerMessage:
                  type: string
                  description: Message that the customer entered (number, optiona) -o the Order Comments box during checkout.
                dateCreated:
                  type: string
                  description: Date created.
                discountAmount:
                  type: string
                  description: Amount of discount for this transaction. (Float, Float-As-String, Integer)
                ebayOrderId:
                  type: string
                  description: >-
                    If the order was placed through eBay, the eBay order number will be included. Otherwise, the value
                    will be 0.
                externalId:
                  type: string
                  description: >-
                    ID of the order in another system. For example, the Amazon Order ID if this is an Amazon order. This
                    field can be updated in a /POST, but using a /PUT to update the order will return a 400 error. The
                    field ‘external_id’ cannot be written to. Please remove it from your request before trying again. It
                    cannot be overwritten once set..
                externalMerchantId:
                  type: string
                  description: Id of the external merchant.
                externalSource:
                  type: string
                  description: >-
                    For orders submitted or modified via the API, using a PUT or POST operation, you can optionally pass
                    in a value identifying the system used to generate the order. For example: POS. Otherwise, the value
                    will be null.
                geoipCountry:
                  type: string
                  description: The full name of the country where the customer made the purchase, based on the IP.
                geoipCountryIso2:
                  type: string
                  description: The country where the customer made the purchase, in ISO2 format, based on the IP.
                giftCertificateAmount:
                  type: string
                  description: A read-only value. Do not pass in a POST or PUT. (Float, Float-As-String, Integer)
                handlingCostExTax:
                  type: string
                  description: The value of the handling cost, excluding tax. (Float, Float-As-String, Integer)
                handlingCostIncTax:
                  type: string
                  description: The value of the handling cost, including tax. (Float, Float-As-String, Integer).
                ipAddress:
                  type: string
                  description: IP Address of the customer, if known.
                isDeleted:
                  type: string
                  description: Indicates whether the order was deleted (archived). Set to true to archive an order.
                itemsShipped:
                  type: string
                  description: The number of items that have been shipped.
                itemsTotal:
                  type: string
                  description: The total number of items in the order.
                orderId:
                  type: string
                  description: BigCommerce order id
                orderIsDigital:
                  type: string
                  description: Whether this is an order for digital products.
                paymentMethod:
                  type: string
                  description: >-
                    The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test
                    Payment Gateway, etc.
                paymentProviderId:
                  type: string
                  description: >-
                    The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider
                    was used).
                poNumber:
                  type: string
                  description: PoNumber
                products:
                  type: array
                  items:
                    $ref: '#/components/schemas/OrdersPutRequestBodyContentApplicationJsonSchemaProductsItems'
                refundedAmount:
                  type: string
                  description: The amount refunded from this transaction. (Float, Float-As-String, Integer)
                shippingCostExTax:
                  type: string
                  description: The value of shipping cost, excluding tax. (Float, Float-As-String, Integer).
                shippingCostIncTax:
                  type: string
                  description: The value of shipping cost, including tax. (Float, Float-As-String, Integer).
                staffNotes:
                  type: string
                  description: Any additional notes for staff.
                statusId:
                  type: string
                  description: The status ID of the order.
                subtotalExTax:
                  type: string
                  description: >-
                    Override value for subtotal excluding tax. If specified, the field subtotal_inc_tax is also
                    required. (Float, Float-As-String, Integer)
                subtotalIncTax:
                  type: string
                  description: >-
                    TOverride value for subtotal including tax. If specified, the field subtotal_ex_tax is also
                    required. (Float, Float-As-String, Integer)
                taxProviderId:
                  type: string
                  description: Tax provider id.
                totalExTax:
                  type: string
                  description: >-
                    Override value for the total, excluding tax. If specified, the field total_inc_tax is also required.
                    (Float, Float-As-String, Integer)
                wrappingCostExTax:
                  type: string
                  description: The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer).
                wrappingCostIncTax:
                  type: string
                  description: The value of the wrapping cost, including tax. (Float, Float-As-String, Integer).
  /orders/company:
    post:
      operationId: orders_company_create
      summary: Update BC Order's 'Company attribute'
      description: >-
        Add Company identifier for BigCommerce Customer Individual Orders, which can be used to convert BigCommerce
        Customer Individual Orders to Company-level Orders.
      tags:
        - order
      parameters:
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order_orders_company_create_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_company_createRequestBadRequestError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                customerID:
                  type: string
                  description: BigCommerce user id.
              required:
                - customerID
    put:
      operationId: orders_company_update
      summary: Update B2BE User's Orders' company attribute.
      description: Update the orders belong to a B2BE company to another B2BE company.
      tags:
        - order
      parameters:
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order_orders_company_update_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_company_updateRequestBadRequestError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                customerGroupID:
                  type: string
                  description: BigCommerce customer group id.
                customerID:
                  type: string
                  description: BigCommerce user id.
              required:
                - customerGroupID
                - customerID
  /orders/images:
    get:
      operationId: orders_images_list
      summary: Get Orders Images
      description: Get all orders' images
      tags:
        - order
      parameters:
        - name: orderIds
          in: query
          description: Query order ids
          required: false
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order_orders_images_list_Response_200'
  /orders/{orderBCId}/companyIdBCId:
    get:
      operationId: orders_companyIdBCId_list
      summary: Get Company By BC OrderId
      description: Get company basic info by bc order id
      tags:
        - order
      parameters:
        - name: orderBCId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order_orders_companyIdBCId_list_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_companyIdBCId_listRequestBadRequestError'
  /orders/{orderId}/companyId:
    get:
      operationId: orders_companyId_list
      summary: Get Company Id By Order Id
      description: Get company ID by order id
      tags:
        - order
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order_orders_companyId_list_Response_200'
  /orders/{orderId}/details:
    get:
      operationId: orders_details_list
      summary: Get Order Detail
      description: Get order's Detail
      tags:
        - order
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order_orders_details_list_Response_200'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_details_listRequestNotFoundError'
  /orders/{orderId}/products:
    get:
      operationId: orders_products_list
      summary: Get Order Product
      description: Get order's products info
      tags:
        - order
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order_orders_products_list_Response_200'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders_products_listRequestNotFoundError'
  /companies/{companyId}/payments:
    get:
      operationId: companies_payments_list
      summary: Get Company Payments Methods
      description: Get company payments methods, include inactive
      tags:
        - payment
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment_companies_payments_list_Response_200'
    put:
      operationId: companies_payments_update
      summary: Update Company Payments Methods
      description: Update Company payments methods' status, change them active or not
      tags:
        - payment
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment_companies_payments_update_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_payments_updateRequestBadRequestError'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_payments_updateRequestNotFoundError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                payments:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CompaniesCompanyIdPaymentsPutRequestBodyContentApplicationJsonSchemaPaymentsItems
  /store/payments:
    get:
      operationId: store_payments_list
      summary: Get Store's All Payments
      description: Get store's all payments
      tags:
        - payment
      parameters:
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment_store_payments_list_Response_200'
  /companies/{companyId}/sales-reps:
    get:
      operationId: companies_sales-reps_list
      summary: Get Company Sales Reps
      description: Get company sales reps' basic info
      tags:
        - salesRep
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalesRep_companies_sales-reps_list_Response_200'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_sales-reps_listRequestNotFoundError'
    put:
      operationId: companies_sales-reps_update
      summary: Update Company Sales reps
      description: Update company reps
      tags:
        - salesRep
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalesRep_companies_sales-reps_update_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_sales-reps_updateRequestBadRequestError'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_sales-reps_updateRequestNotFoundError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                salesReps:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CompaniesCompanyIdSalesRepsPutRequestBodyContentApplicationJsonSchemaSalesRepsItems
  /sales-reps/companies:
    get:
      operationId: sales-reps_companies_list
      summary: Get Companies & Sales reps
      description: Get all companies and their sales reps, default order by company
      tags:
        - salesRep
      parameters:
        - name: offset
          in: query
          description: 'Pagination offset default: 0'
          required: false
          schema:
            type: number
            format: double
        - name: limit
          in: query
          description: 'Pagination limit default: 10'
          required: false
          schema:
            type: number
            format: double
        - name: groupBy
          in: query
          description: Group by('2' for company, '1' for sales reps)
          required: false
          schema:
            type: number
            format: double
        - name: orderBy
          in: query
          description: Order by default DESC choice (DESC ASC)
          required: false
          schema:
            type: number
            format: double
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalesRep_sales-reps_companies_list_Response_200'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sales-reps_companies_listRequestNotFoundError'
  /companies/{companyId}/user/{userId}:
    put:
      operationId: companies_user_update
      summary: Update A Company User
      description: Update a company user info
      tags:
        - user
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: userId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_companies_user_update_Response_200'
      requestBody:
        description: Extra Field Values
        content:
          application/json:
            schema:
              type: object
              properties:
                firstName:
                  type: string
                lastName:
                  type: string
                phone:
                  type: string
                email:
                  type: string
                uuid:
                  type: string
                userRole:
                  type: string
                acceptWelcomeEmail:
                  type: string
                channelIds:
                  type: array
                  items:
                    type: integer
                  description: BigCommerce channel id list.
                companyRoleId:
                  type: integer
                  description: >-
                    The company role id. This field is only applicable to the company's RBAC feature. If your store
                    doesn't utilize this feature, please do not use this field. When it has a value, it will override
                    the value of the userRole field.
                extraFields:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CompaniesCompanyIdUserUserIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems
  /companies/{companyId}/users:
    get:
      operationId: companies_users_list
      summary: Get Company Users
      description: Get company users, with pagination data
      tags:
        - user
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: offset
          in: query
          description: 'Pagination offset default: 0'
          required: false
          schema:
            type: number
            format: double
        - name: limit
          in: query
          description: 'Pagination limit default: 10'
          required: false
          schema:
            type: number
            format: double
        - name: role[]
          in: query
          description: user role(0=admin 1=senior_buyer 2=junior_buyer 3=sales_rep) eg. role[]=1, 2
          required: false
          schema:
            type: string
        - name: isIncludeExtraFields
          in: query
          description: 0 or 1
          required: false
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_companies_users_list_Response_200'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_users_listRequestNotFoundError'
    post:
      operationId: companies_users_create
      summary: Create A Company User
      description: Create a company user, which belongs company
      tags:
        - user
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_companies_users_create_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_users_createRequestBadRequestError'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_users_createRequestNotFoundError'
      requestBody:
        description: Extra Field Values
        content:
          application/json:
            schema:
              type: object
              properties:
                acceptWelcomeEmail:
                  $ref: >-
                    #/components/schemas/CompaniesCompanyIdUsersPostRequestBodyContentApplicationJsonSchemaAcceptWelcomeEmail
                  description: (0=will not receive email 1=will receive email)
                email:
                  type: string
                firstName:
                  type: string
                lastName:
                  type: string
                phone:
                  type: string
                userRole:
                  type: string
                  description: user role(0=admin 1=senior_buyer 2=junior_buyer 3=sales_rep)
                uuid:
                  type: string
                channelIds:
                  type: array
                  items:
                    type: integer
                  description: BigCommerce channel id list
                originChannelId:
                  type: integer
                  description: >-
                    BigCommerce channel id, used for BigCommerce customer origin channel id. This field takes effect
                    only when the store default b2b channel is not configured
                companyRoleId:
                  type: integer
                  description: >-
                    The company role id. This field is only applicable to the company's RBAC feature. If your store
                    doesn't utilize this feature, please do not use this field. When it has a value, it will override
                    the value of the userRole field.
                extraFields:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CompaniesCompanyIdUsersPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems
              required:
                - email
                - firstName
                - lastName
                - phone
    put:
      operationId: companies_users_update_or_create
      summary: Update Company User
      description: Update company user's field, user identified by email field.fields can not omit
      tags:
        - user
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_companies_users_update_or_create_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_users_update_or_createRequestBadRequestError'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_users_update_or_createRequestNotFoundError'
      requestBody:
        description: Extra Field Values
        content:
          application/json:
            schema:
              type: object
              properties:
                acceptWelcomeEmail:
                  $ref: >-
                    #/components/schemas/CompaniesCompanyIdUsersPutRequestBodyContentApplicationJsonSchemaAcceptWelcomeEmail
                  description: (0=will not receive email 1=will receive email)
                email:
                  type: string
                firstName:
                  type: string
                lastName:
                  type: string
                phone:
                  type: string
                userRole:
                  type: string
                  description: user role(0=admin 1=senior_buyer 2=junior_buyer 3=sales_rep)
                uuid:
                  type: string
                channelIds:
                  type: array
                  items:
                    type: integer
                  description: BigCommerce channel id list
                companyRoleId:
                  type: integer
                  description: >-
                    The company role id. This field is only applicable to the company's RBAC feature. If your store
                    doesn't utilize this feature, please do not use this field. When it has a value, it will override
                    the value of the userRole field.
                extraFields:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CompaniesCompanyIdUsersPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems
              required:
                - email
                - firstName
                - lastName
  /companies/{companyId}/users/bulk_create:
    post:
      operationId: companies_users_bulk_create_create
      summary: Bulk Create Company User
      description: Create company users in batch
      tags:
        - user
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_companies_users_bulk_create_create_Response_200'
        '400':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_users_bulk_create_createRequestBadRequestError'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_users_bulk_create_createRequestNotFoundError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                acceptWelcomeEmail:
                  $ref: >-
                    #/components/schemas/CompaniesCompanyIdUsersBulkCreatePostRequestBodyContentApplicationJsonSchemaAcceptWelcomeEmail
                  description: (0=will not receive email 1=will receive email)
                users:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CompaniesCompanyIdUsersBulkCreatePostRequestBodyContentApplicationJsonSchemaUsersItems
  /companies/{companyId}/users/{customerId}:
    get:
      operationId: companies_users_read
      summary: Get A Company User
      description: Get a company user's info, by company and customer id
      tags:
        - user
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: customerId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_companies_users_read_Response_200'
        '404':
          description: Not Found Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_users_readRequestNotFoundError'
    delete:
      operationId: companies_users_delete
      summary: Delete A Company User
      description: Delete a company user, if this user is the only one administrator of company, will return a 500 Error
      tags:
        - user
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
        - name: customerId
          in: path
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Deleted successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_companies_users_delete_Response_200'
        '404':
          description: Company not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Companies_users_deleteRequestNotFoundError'
  /proxy:
    post:
      operationId: create
      summary: Third party API proxy
      description: Get response data of third party APIs through this API.
      tags:
        - proxy
      parameters:
        - name: authToken
          in: header
          required: true
          schema:
            type: string
        - name: authToken
          in: header
          description: Auth token in header.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Proxy_create_Response_200'
        '500':
          description: Response Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Proxy_createRequestInternalServerError'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: string
                  description: Request data of your third party request
                method:
                  type: string
                  description: HTTP request method, get/post/put/delete
                params:
                  type: string
                  description: Request parameters of your third party request
                proxyType:
                  type: string
                  description: Third party type or name, such as BigCommerce
                url:
                  type: string
                  description: Url of request
              required:
                - method
                - proxyType
                - url
servers:
  - url: https://api-b2b.bigcommerce.com/api/v2/io
    description: https://api-b2b.bigcommerce.com/api/v2/io
components:
  schemas:
    AddressesCountryStateGetParametersSearchType:
      type: string
      enum:
        - code
        - name
      title: AddressesCountryStateGetParametersSearchType
    AddressesCountryStateGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: AddressesCountryStateGetResponsesContentApplicationJsonSchemaData
    Address_addresses_country_state_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/AddressesCountryStateGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Address_addresses_country_state_list_Response_200
    Addresses_country_state_listRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/AddressesCountryStateGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Addresses_country_state_listRequestNotFoundError
    CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressIdCountry:
      type: object
      properties:
        countryCode:
          type: string
          description: ISO 3166-1 Alpha 2 Country Code
        countryName:
          type: string
          description: Human readable country name
      title: CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressIdCountry
    CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressIdState:
      type: object
      properties:
        stateCode:
          type: string
          description: ISO 3166-2 Alpha 2 Country Subdivision Code
        stateName:
          type: string
          description: Human readable state (or other subdivision) name
      title: CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressIdState
    CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressId:
      type: object
      properties:
        addressId:
          type: string
          description: Identifier for the address (same as URL parameter addressId)
        addressLine1:
          type: string
          description: Typically the street address
        addressLine2:
          type: string
          description: More detailed information about where to deliver mail, such as a suite or office number
        city:
          type: string
        country:
          $ref: >-
            #/components/schemas/CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressIdCountry
        firstName:
          type: string
        isBilling:
          type: boolean
          description: Indicates whether the address is a billing address
        isDefaultBilling:
          type: boolean
        isDefaultShipping:
          type: boolean
        isShipping:
          type: boolean
          description: Indicates whether the address is a shipping address
        lastName:
          type: string
        phoneNumber:
          type: string
        state:
          $ref: >-
            #/components/schemas/CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressIdState
        zipCode:
          type: string
          description: A valid postal code used by the country that was specified
        externalId:
          type: string
      description: The map from address ID to address
      title: CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressId
    CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddresses:
      type: object
      properties:
        '[address_id]':
          $ref: >-
            #/components/schemas/CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddressesAddressId
          description: The map from address ID to address
        defaultBillingId:
          type: number
          format: double
          description: The identifier of the default shipping address
        defaultShippingId:
          type: number
          format: double
          description: The identifier of the default shipping address
      description: All addresses
      title: CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddresses
    CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        addresses:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaDataAddresses'
          description: All addresses
      description: Response data
      title: CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaData
    Address_companies_addresses_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Address_companies_addresses_list_Response_200
    CompaniesCompanyIdAddressesPostRequestBodyContentApplicationJsonSchemaCountry:
      type: object
      properties:
        countryCode:
          type: string
          description: ISO 3166-1 Alpha 2 Country Code
        countryName:
          type: string
          description: Human readable country name
      title: CompaniesCompanyIdAddressesPostRequestBodyContentApplicationJsonSchemaCountry
    CompaniesCompanyIdAddressesPostRequestBodyContentApplicationJsonSchemaState:
      type: object
      properties:
        stateCode:
          type: string
          description: ISO 3166-2 Alpha 2 Country Subdivision Code
        stateName:
          type: string
          description: Human readable state (or other subdivision) name
      title: CompaniesCompanyIdAddressesPostRequestBodyContentApplicationJsonSchemaState
    CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaDataErrMsgItems:
      type: object
      properties:
        '[field]':
          type: string
          description: field error description.
      title: CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaDataErrMsgItems
    CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: array
          items:
            $ref: '#/components/schemas/CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaDataErrMsgItems'
          description: Message about problem with field 'field'
      description: Response error data
      title: CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaData
    CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaMeta:
      type: object
      properties:
        message:
          type: string
          description: Response error message
      title: CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaMeta
    Address_companies_addresses_create_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaData'
          description: Response data
        meta:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaMeta'
      title: Address_companies_addresses_create_Response_200
    Companies_addresses_createRequestUnprocessableEntityError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status error code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaData'
          description: Response error data
        meta:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesPostResponsesContentApplicationJsonSchemaMeta'
      description: Response body
      title: Companies_addresses_createRequestUnprocessableEntityError
    CompaniesCompanyIdAddressesAddressIdGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdAddressesAddressIdGetResponsesContentApplicationJsonSchemaData
    Address_companies_addresses_read_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesAddressIdGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Address_companies_addresses_read_Response_200
    Companies_addresses_readRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesAddressIdGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_addresses_readRequestNotFoundError
    CompaniesCompanyIdAddressesAddressIdPutRequestBodyContentApplicationJsonSchemaCountry:
      type: object
      properties:
        countryCode:
          type: string
          description: ISO 3166-1 Alpha 2 Country Code
        countryName:
          type: string
          description: Human readable country name
      title: CompaniesCompanyIdAddressesAddressIdPutRequestBodyContentApplicationJsonSchemaCountry
    CompaniesCompanyIdAddressesAddressIdPutRequestBodyContentApplicationJsonSchemaState:
      type: object
      properties:
        stateCode:
          type: string
          description: ISO 3166-2 Alpha 2 Country Subdivision Code
        stateName:
          type: string
          description: Human readable state (or other subdivision) name
      title: CompaniesCompanyIdAddressesAddressIdPutRequestBodyContentApplicationJsonSchemaState
    CompaniesCompanyIdAddressesAddressIdPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdAddressesAddressIdPutResponsesContentApplicationJsonSchemaData
    Address_companies_addresses_update_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesAddressIdPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Address_companies_addresses_update_Response_200
    Companies_addresses_updateRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status error code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesAddressIdPutResponsesContentApplicationJsonSchemaData'
          description: Response error data
        message:
          type: string
          description: Response error message
      description: Response body
      title: Companies_addresses_updateRequestBadRequestError
    Companies_addresses_updateRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesAddressIdPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_addresses_updateRequestNotFoundError
    CompaniesCompanyIdAddressesAddressIdDeleteResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      description: Response data
      title: CompaniesCompanyIdAddressesAddressIdDeleteResponsesContentApplicationJsonSchemaData
    Address_companies_addresses_delete_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesAddressIdDeleteResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Address_companies_addresses_delete_Response_200
    Companies_addresses_deleteRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdAddressesAddressIdDeleteResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_addresses_deleteRequestNotFoundError
    CompaniesConvertFromCustomerGroupPostRequestBodyContentApplicationJsonSchemaAcceptWelcomeEmail:
      type: string
      enum:
        - '0'
        - '1'
      description: (0=will not receive email 1=will receive email)
      title: CompaniesConvertFromCustomerGroupPostRequestBodyContentApplicationJsonSchemaAcceptWelcomeEmail
    CompaniesConvertFromCustomerGroupPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
        fieldValue:
          type: string
      title: CompaniesConvertFromCustomerGroupPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems
    CompaniesConvertFromCustomerGroupPostRequestBodyContentApplicationJsonSchemaUserExtraFieldsItems:
      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: CompaniesConvertFromCustomerGroupPostRequestBodyContentApplicationJsonSchemaUserExtraFieldsItems
    CompaniesConvertFromCustomerGroupPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesConvertFromCustomerGroupPostResponsesContentApplicationJsonSchemaData
    Company_companies_convert-from-customer-group_create_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesConvertFromCustomerGroupPostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Company_companies_convert-from-customer-group_create_Response_200
    Companies_convert-from-customer-group_createRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status error code
        data:
          $ref: '#/components/schemas/CompaniesConvertFromCustomerGroupPostResponsesContentApplicationJsonSchemaData'
          description: Response error data
        message:
          type: string
          description: Response error message
      description: Response body
      title: Companies_convert-from-customer-group_createRequestBadRequestError
    Companies_convert-from-customer-group_createRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesConvertFromCustomerGroupPostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_convert-from-customer-group_createRequestNotFoundError
    CompaniesCompanyIdBasicInfoGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdBasicInfoGetResponsesContentApplicationJsonSchemaData
    Company_companies_basic-info_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdBasicInfoGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Company_companies_basic-info_list_Response_200
    Companies_basic-info_listRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdBasicInfoGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_basic-info_listRequestNotFoundError
    CompaniesCompanyIdBasicInfoPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
        fieldValue:
          type: string
      title: CompaniesCompanyIdBasicInfoPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems
    CompaniesCompanyIdBasicInfoPutRequestBodyContentApplicationJsonSchemaPriceListAssignItems:
      type: object
      properties:
        channelId:
          type: integer
          description: BigCommerce channel id
        priceListId:
          type: integer
          description: BC price list ID
      title: CompaniesCompanyIdBasicInfoPutRequestBodyContentApplicationJsonSchemaPriceListAssignItems
    CompaniesCompanyIdBasicInfoPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdBasicInfoPutResponsesContentApplicationJsonSchemaData
    Company_companies_basic-info_update_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdBasicInfoPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Company_companies_basic-info_update_Response_200
    Companies_basic-info_updateRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdBasicInfoPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_basic-info_updateRequestNotFoundError
    CompaniesCompanyIdForceDelDeleteResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      description: Response data
      title: CompaniesCompanyIdForceDelDeleteResponsesContentApplicationJsonSchemaData
    Company_companies_force-del_delete_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdForceDelDeleteResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Company_companies_force-del_delete_Response_200
    Companies_force-del_deleteRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdForceDelDeleteResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_force-del_deleteRequestNotFoundError
    CompaniesCompanyIdOrderBcIdsGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdOrderBcIdsGetResponsesContentApplicationJsonSchemaData
    Company_companies_orderBCIds_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdOrderBcIdsGetResponsesContentApplicationJsonSchemaData'
        message:
          type: string
          description: Response message
      title: Company_companies_orderBCIds_list_Response_200
    Companies_orderBCIds_listRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdOrderBcIdsGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_orderBCIds_listRequestNotFoundError
    UsersCustomerIdCompaniesGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: UsersCustomerIdCompaniesGetResponsesContentApplicationJsonSchemaData
    Company_users_companies_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/UsersCustomerIdCompaniesGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Company_users_companies_list_Response_200
    Users_companies_listRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/UsersCustomerIdCompaniesGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Users_companies_listRequestNotFoundError
    CompaniesUsersCustomerIdOrdersPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesUsersCustomerIdOrdersPostResponsesContentApplicationJsonSchemaData
    Order_companies_users_orders_create_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesUsersCustomerIdOrdersPostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Order_companies_users_orders_create_Response_200
    Companies_users_orders_createRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status error code
        data:
          $ref: '#/components/schemas/CompaniesUsersCustomerIdOrdersPostResponsesContentApplicationJsonSchemaData'
          description: Response error data
        message:
          type: string
          description: Response error message
      description: Response body
      title: Companies_users_orders_createRequestBadRequestError
    Companies_users_orders_createRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesUsersCustomerIdOrdersPostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_users_orders_createRequestNotFoundError
    CompaniesCompanyIdOrdersGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdOrdersGetResponsesContentApplicationJsonSchemaData
    Order_companies_orders_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdOrdersGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Order_companies_orders_list_Response_200
    Companies_orders_listRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdOrdersGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_orders_listRequestNotFoundError
    CompaniesCompanyIdUserCustomerIdOrdersPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdUserCustomerIdOrdersPostResponsesContentApplicationJsonSchemaData
    Order_companies_user_orders_create_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUserCustomerIdOrdersPostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Order_companies_user_orders_create_Response_200
    Companies_user_orders_createRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status error code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUserCustomerIdOrdersPostResponsesContentApplicationJsonSchemaData'
          description: Response error data
        message:
          type: string
          description: Response error message
      description: Response body
      title: Companies_user_orders_createRequestBadRequestError
    Companies_user_orders_createRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUserCustomerIdOrdersPostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_user_orders_createRequestNotFoundError
    OrdersPutRequestBodyContentApplicationJsonSchemaBillingAddress:
      type: object
      properties:
        city:
          type: string
        company:
          type: string
          description: Company name
        country:
          type: string
          description: Human readable country name
        countryIso2:
          type: string
          description: Country ISO info.
        email:
          type: string
          description: Address email.
        firstName:
          type: string
          description: Address first name
        formFields:
          type: string
          description: Address form fields.
        lastName:
          type: string
          description: Address last name
        phone:
          type: string
          description: Address phone number
        state:
          type: string
          description: Human readable state (or other subdivision) name
        streetOne:
          type: string
          description: Typically the street address
        streetTwo:
          type: string
          description: More detailed information about where to deliver mail, such as a suite or office number
        zip:
          type: string
      title: OrdersPutRequestBodyContentApplicationJsonSchemaBillingAddress
    OrdersPutRequestBodyContentApplicationJsonSchemaProductsItems:
      type: object
      properties:
        name:
          type: string
        priceExTax:
          type: string
        priceIncTax:
          type: string
        productId:
          type: string
          description: Product id.
        productOptions:
          type: string
        quantity:
          type: string
        sku:
          type: string
        upc:
          type: string
        variantId:
          type: string
      title: OrdersPutRequestBodyContentApplicationJsonSchemaProductsItems
    OrdersPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: OrdersPutResponsesContentApplicationJsonSchemaData
    Order_orders_update_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/OrdersPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Order_orders_update_Response_200
    Orders_updateRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status error code
        data:
          $ref: '#/components/schemas/OrdersPutResponsesContentApplicationJsonSchemaData'
          description: Response error data
        message:
          type: string
          description: Response error message
      description: Response body
      title: Orders_updateRequestBadRequestError
    Orders_updateRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/OrdersPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Orders_updateRequestNotFoundError
    OrdersCompanyPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        '[field]':
          type: string
          description: Message about problem with field 'field'
      description: Response error data
      title: OrdersCompanyPostResponsesContentApplicationJsonSchemaData
    Order_orders_company_create_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/OrdersCompanyPostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Order_orders_company_create_Response_200
    Orders_company_createRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status error code
        data:
          $ref: '#/components/schemas/OrdersCompanyPostResponsesContentApplicationJsonSchemaData'
          description: Response error data
        message:
          type: string
          description: Response error message
      description: Response body
      title: Orders_company_createRequestBadRequestError
    OrdersCompanyPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        '[field]':
          type: string
          description: Message about problem with field 'field'
      description: Response error data
      title: OrdersCompanyPutResponsesContentApplicationJsonSchemaData
    Order_orders_company_update_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/OrdersCompanyPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Order_orders_company_update_Response_200
    Orders_company_updateRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status error code
        data:
          $ref: '#/components/schemas/OrdersCompanyPutResponsesContentApplicationJsonSchemaData'
          description: Response error data
        message:
          type: string
          description: Response error message
      description: Response body
      title: Orders_company_updateRequestBadRequestError
    OrdersImagesGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        imageUrl:
          type: string
          description: Image url.
        orderId:
          type: string
          description: Order id.
      title: OrdersImagesGetResponsesContentApplicationJsonSchemaDataItems
    Order_orders_images_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrdersImagesGetResponsesContentApplicationJsonSchemaDataItems'
        message:
          type: string
          description: Response message
      title: Order_orders_images_list_Response_200
    OrdersOrderBcIdCompanyIdBcIdGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        '[field]':
          type: string
          description: Message about problem with field 'field'
      description: Response error data
      title: OrdersOrderBcIdCompanyIdBcIdGetResponsesContentApplicationJsonSchemaData
    Order_orders_companyIdBCId_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/OrdersOrderBcIdCompanyIdBcIdGetResponsesContentApplicationJsonSchemaData'
        message:
          type: string
          description: Response message
      title: Order_orders_companyIdBCId_list_Response_200
    Orders_companyIdBCId_listRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status error code
        data:
          $ref: '#/components/schemas/OrdersOrderBcIdCompanyIdBcIdGetResponsesContentApplicationJsonSchemaData'
          description: Response error data
        message:
          type: string
          description: Response error message
      description: Response body
      title: Orders_companyIdBCId_listRequestBadRequestError
    OrdersOrderIdCompanyIdGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        companyId:
          type: string
          description: Company id
      title: OrdersOrderIdCompanyIdGetResponsesContentApplicationJsonSchemaData
    Order_orders_companyId_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/OrdersOrderIdCompanyIdGetResponsesContentApplicationJsonSchemaData'
        message:
          type: string
          description: Response message
      title: Order_orders_companyId_list_Response_200
    OrdersOrderIdDetailsGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: OrdersOrderIdDetailsGetResponsesContentApplicationJsonSchemaData
    Order_orders_details_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/OrdersOrderIdDetailsGetResponsesContentApplicationJsonSchemaData'
        message:
          type: string
          description: Response message
      title: Order_orders_details_list_Response_200
    Orders_details_listRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/OrdersOrderIdDetailsGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Orders_details_listRequestNotFoundError
    OrdersOrderIdProductsGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: OrdersOrderIdProductsGetResponsesContentApplicationJsonSchemaData
    Order_orders_products_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/OrdersOrderIdProductsGetResponsesContentApplicationJsonSchemaData'
        message:
          type: string
          description: Response message
      title: Order_orders_products_list_Response_200
    Orders_products_listRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/OrdersOrderIdProductsGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Orders_products_listRequestNotFoundError
    CompaniesCompanyIdPaymentsGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        code:
          type: string
          description: Payment code
        isEnabled:
          type: string
          description: Payment method status
        name:
          type: string
          description: Payment name
        paymentId:
          type: number
          format: double
          description: Payment id
      title: CompaniesCompanyIdPaymentsGetResponsesContentApplicationJsonSchemaDataItems
    Payment_companies_payments_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          type: array
          items:
            $ref: '#/components/schemas/CompaniesCompanyIdPaymentsGetResponsesContentApplicationJsonSchemaDataItems'
        message:
          type: string
          description: Response message
      title: Payment_companies_payments_list_Response_200
    CompaniesCompanyIdPaymentsPutRequestBodyContentApplicationJsonSchemaPaymentsItems:
      type: object
      properties:
        isEnabled:
          type: string
          description: payment active or not('1' for active, others for inactive)
        paymentId:
          type: string
          description: Payment Id
      required:
        - isEnabled
        - paymentId
      title: CompaniesCompanyIdPaymentsPutRequestBodyContentApplicationJsonSchemaPaymentsItems
    CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaData
    Payment_companies_payments_update_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Payment_companies_payments_update_Response_200
    Companies_payments_updateRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status error code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaData'
          description: Response error data
        message:
          type: string
          description: Response error message
      description: Response body
      title: Companies_payments_updateRequestBadRequestError
    Companies_payments_updateRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_payments_updateRequestNotFoundError
    StorePaymentsGetResponsesContentApplicationJsonSchemaDataListItems:
      type: object
      properties:
        paymentCode:
          type: string
          description: Payment method code
        paymentTitle:
          type: string
          description: Payment method title
      title: StorePaymentsGetResponsesContentApplicationJsonSchemaDataListItems
    StorePaymentsGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/StorePaymentsGetResponsesContentApplicationJsonSchemaDataListItems'
      description: Response data
      title: StorePaymentsGetResponsesContentApplicationJsonSchemaData
    Payment_store_payments_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/StorePaymentsGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: Payment_store_payments_list_Response_200
    CompaniesCompanyIdSalesRepsGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdSalesRepsGetResponsesContentApplicationJsonSchemaData
    SalesRep_companies_sales-reps_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdSalesRepsGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: SalesRep_companies_sales-reps_list_Response_200
    Companies_sales-reps_listRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdSalesRepsGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_sales-reps_listRequestNotFoundError
    CompaniesCompanyIdSalesRepsPutRequestBodyContentApplicationJsonSchemaSalesRepsItems:
      type: object
      properties:
        id:
          type: string
          description: Sales rep's Id
      title: CompaniesCompanyIdSalesRepsPutRequestBodyContentApplicationJsonSchemaSalesRepsItems
    CompaniesCompanyIdSalesRepsPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdSalesRepsPutResponsesContentApplicationJsonSchemaData
    SalesRep_companies_sales-reps_update_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdSalesRepsPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: SalesRep_companies_sales-reps_update_Response_200
    Companies_sales-reps_updateRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdSalesRepsPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_sales-reps_updateRequestBadRequestError
    Companies_sales-reps_updateRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdSalesRepsPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_sales-reps_updateRequestNotFoundError
    SalesRepsCompaniesGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: SalesRepsCompaniesGetResponsesContentApplicationJsonSchemaData
    SalesRep_sales-reps_companies_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/SalesRepsCompaniesGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: SalesRep_sales-reps_companies_list_Response_200
    Sales-reps_companies_listRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/SalesRepsCompaniesGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Sales-reps_companies_listRequestNotFoundError
    CompaniesCompanyIdUserUserIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems:
      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: CompaniesCompanyIdUserUserIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems
    CompaniesCompanyIdUserUserIdPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        customerId:
          type: integer
        userId:
          type: integer
      description: Response data
      title: CompaniesCompanyIdUserUserIdPutResponsesContentApplicationJsonSchemaData
    User_companies_user_update_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUserUserIdPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: User_companies_user_update_Response_200
    CompaniesCompanyIdUsersGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdUsersGetResponsesContentApplicationJsonSchemaData
    User_companies_users_list_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: User_companies_users_list_Response_200
    Companies_users_listRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_users_listRequestNotFoundError
    CompaniesCompanyIdUsersPostRequestBodyContentApplicationJsonSchemaAcceptWelcomeEmail:
      type: string
      enum:
        - '0'
        - '1'
      description: (0=will not receive email 1=will receive email)
      title: CompaniesCompanyIdUsersPostRequestBodyContentApplicationJsonSchemaAcceptWelcomeEmail
    CompaniesCompanyIdUsersPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems:
      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: CompaniesCompanyIdUsersPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems
    CompaniesCompanyIdUsersPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdUsersPostResponsesContentApplicationJsonSchemaData
    User_companies_users_create_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersPostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: User_companies_users_create_Response_200
    Companies_users_createRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersPostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_users_createRequestBadRequestError
    Companies_users_createRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersPostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_users_createRequestNotFoundError
    CompaniesCompanyIdUsersPutRequestBodyContentApplicationJsonSchemaAcceptWelcomeEmail:
      type: string
      enum:
        - '0'
        - '1'
      description: (0=will not receive email 1=will receive email)
      title: CompaniesCompanyIdUsersPutRequestBodyContentApplicationJsonSchemaAcceptWelcomeEmail
    CompaniesCompanyIdUsersPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems:
      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: CompaniesCompanyIdUsersPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems
    CompaniesCompanyIdUsersPutResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdUsersPutResponsesContentApplicationJsonSchemaData
    User_companies_users_update_or_create_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: User_companies_users_update_or_create_Response_200
    Companies_users_update_or_createRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_users_update_or_createRequestBadRequestError
    Companies_users_update_or_createRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersPutResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_users_update_or_createRequestNotFoundError
    CompaniesCompanyIdUsersBulkCreatePostRequestBodyContentApplicationJsonSchemaAcceptWelcomeEmail:
      type: string
      enum:
        - '0'
        - '1'
      description: (0=will not receive email 1=will receive email)
      title: CompaniesCompanyIdUsersBulkCreatePostRequestBodyContentApplicationJsonSchemaAcceptWelcomeEmail
    CompaniesCompanyIdUsersBulkCreatePostRequestBodyContentApplicationJsonSchemaUsersItemsExtraFieldsItems:
      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: CompaniesCompanyIdUsersBulkCreatePostRequestBodyContentApplicationJsonSchemaUsersItemsExtraFieldsItems
    CompaniesCompanyIdUsersBulkCreatePostRequestBodyContentApplicationJsonSchemaUsersItems:
      type: object
      properties:
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        phone:
          type: string
        userRole:
          type: string
          description: user role(0=admin 1=senior_buyer 2=junior_buyer 3=sales_rep)
        channelIds:
          type: array
          items:
            type: integer
          description: BigCommerce channel id list
        originChannelId:
          type: integer
          description: >-
            BigCommerce channel id, used for BigCommerce customer origin channel id. This field takes effect only when
            the store default b2b channel is not configured
        companyRoleId:
          type: integer
          description: >-
            The company role id. This field is only applicable to the company's RBAC feature. If your store doesn't
            utilize this feature, please do not use this field. When it has a value, it will override the value of the
            userRole field.
        extraFields:
          type: array
          items:
            $ref: >-
              #/components/schemas/CompaniesCompanyIdUsersBulkCreatePostRequestBodyContentApplicationJsonSchemaUsersItemsExtraFieldsItems
      required:
        - email
        - firstName
        - lastName
        - phone
      description: Extra Field Values
      title: CompaniesCompanyIdUsersBulkCreatePostRequestBodyContentApplicationJsonSchemaUsersItems
    CompaniesCompanyIdUsersBulkCreatePostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdUsersBulkCreatePostResponsesContentApplicationJsonSchemaData
    User_companies_users_bulk_create_create_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersBulkCreatePostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: User_companies_users_bulk_create_create_Response_200
    Companies_users_bulk_create_createRequestBadRequestError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersBulkCreatePostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_users_bulk_create_createRequestBadRequestError
    Companies_users_bulk_create_createRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersBulkCreatePostResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_users_bulk_create_createRequestNotFoundError
    CompaniesCompanyIdUsersCustomerIdGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        errMsg:
          type: string
          description: Error message info
      description: Response data
      title: CompaniesCompanyIdUsersCustomerIdGetResponsesContentApplicationJsonSchemaData
    User_companies_users_read_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersCustomerIdGetResponsesContentApplicationJsonSchemaData'
          description: Extra Field Values
        message:
          type: string
          description: Response message
      title: User_companies_users_read_Response_200
    Companies_users_readRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersCustomerIdGetResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_users_readRequestNotFoundError
    CompaniesCompanyIdUsersCustomerIdDeleteResponsesContentApplicationJsonSchemaData:
      type: object
      properties: {}
      description: Response data
      title: CompaniesCompanyIdUsersCustomerIdDeleteResponsesContentApplicationJsonSchemaData
    User_companies_users_delete_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersCustomerIdDeleteResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      title: User_companies_users_delete_Response_200
    Companies_users_deleteRequestNotFoundError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        data:
          $ref: '#/components/schemas/CompaniesCompanyIdUsersCustomerIdDeleteResponsesContentApplicationJsonSchemaData'
          description: Response data
        message:
          type: string
          description: Response message
      description: Response body
      title: Companies_users_deleteRequestNotFoundError
    Proxy_create_Response_200:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status code
        message:
          type: string
          description: Response message
      title: Proxy_create_Response_200
    Proxy_createRequestInternalServerError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: Response status error code
        message:
          type: string
          description: Response error message
      description: Response body
      title: Proxy_createRequestInternalServerError
  securitySchemes:
    authToken:
      type: apiKey
      in: header
      name: authToken
