Codat Sales API

Retrieve standardized sales data from a linked commerce software.

OpenAPI Specification

codat-sales-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Bank Feeds Account mapping Sales API
  version: 3.0.0
  contact:
    email: support@codat.io
    name: Codat
  description: 'Bank Feeds solution enables your SMB users to set up bank feeds from accounts in your application to supported accounting software.


    A bank feed is a connection between a source bank account in your application and a target bank account in a supported accounting software.


    [Explore solution](https://docs.codat.io/bank-feeds-api/overview) | [See OpenAPI spec](https://github.com/codatio/oas)


    ---

    <!-- Start Codat Tags Table -->

    ## Endpoints


    | Endpoints | Description |

    | :- |:- |

    | Companies | Create and manage your SMB users'' companies. |

    | Connections | Create new and manage existing data connections for a company. |

    | Source accounts | Provide and manage lists of source bank accounts. |

    | Account mapping | Extra functionality for building an account management UI. |

    | Company information | Get detailed information about a company from the underlying platform. |

    | Transactions | Create new bank account transactions for a company''s connections, and see previous operations. |

    <!-- End Codat Tags Table -->'
  termsOfService: https://www.codat.io/legals/
servers:
- description: Production
  url: https://api.codat.io
security:
- auth_header: []
tags:
- name: Sales
  description: Retrieve standardized sales data from a linked commerce software.
paths:
  /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/connectionId'
    get:
      summary: Get commerce revenue metrics
      tags:
      - Sales
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceReport'
              example:
              - reportInfo:
                  name: revenue
                  displayName: Revenue
                dimensions:
                - index: 0
                  displayName: Period
                  type: datespan
                  items:
                  - index: 0
                    displayName: Period 0
                    start: '2022-01-01'
                    end: '2022-12-31'
                - index: 1
                  displayName: Revenue metrics
                  type: string
                  items:
                  - index: 0
                    value: Revenue
                  - index: 1
                    value: Revenue growth
                measures:
                - displayName: Value
                  units: GBP
                  index: 0
                  type: currency
                - displayName: Percentage change vs. previous period
                  units: '%'
                  index: 1
                  type: percentage
                reportData:
                - dimension: 0
                  dimensionDisplayName: Period
                  item: 0
                  itemDisplayName: Period 0
                  components:
                  - dimension: 1
                    dimensionDisplayName: Revenue metrics
                    item: 0
                    itemDisplayName: Revenue
                    measures:
                    - index: 0
                      measureDisplayName: Value
                      value: 2392.48
                  - dimension: 1
                    dimensionDisplayName: Revenue metrics
                    item: 1
                    itemDisplayName: Revenue growth
                    measures:
                    - index: 1
                      measureDisplayName: Percentage change vs. previous period
                      value: 276.65
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment-Required'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
      operationId: get-commerce-revenue-metrics
      x-speakeasy-name-override: get-revenue
      x-speakeasy-group: sales.metrics
      description: "The *Get revenue report* endpoint returns the revenue and revenue growth for a specific company connection over one or more periods of time.\n\nThis detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. \n\n[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the revenue metrics.\n\n#### Response structure\n\nThe Revenue report's dimensions and measures are:\n\n| Index         | Dimensions |\n|---------------|------------|\n|   `index` = 0 | Period     |\n|   `index` = 1 | Revenue    |\n\n| Index         | Measures                                                                                                                 |\n|---------------|--------------------------------------------------------------------------------------------------------------------------|\n| `index` = 0   | Value                                                                                                                    |\n| `index` = 1   | Percentage change, defined as the change between the current and previous periods' values and expressed as a percentage. |\n\nThe report data then combines multiple reporting dimensions and measures and outputs the value of each combination.\n"
      parameters:
      - $ref: '#/components/parameters/reportDateRequired'
      - $ref: '#/components/parameters/periodLength'
      - $ref: '#/components/parameters/numberOfPeriodsRequired'
      - $ref: '#/components/parameters/periodUnit'
      - $ref: '#/components/parameters/includeDisplayNames'
  /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/connectionId'
    get:
      summary: Get orders report
      tags:
      - Sales
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceReport'
              example:
              - reportInfo:
                  name: orders
                  displayName: Orders
                dimensions:
                - index: 0
                  displayName: Period
                  type: datespan
                  items:
                  - index: 0
                    displayName: Period 0
                    start: '2022-01-01'
                    end: '2022-12-31'
                - index: 1
                  displayName: Order metrics
                  type: string
                  items:
                  - index: 0
                    value: Number of orders
                  - index: 1
                    value: Total value
                  - index: 2
                    value: Average order value
                measures:
                - displayName: Count
                  index: 0
                  type: int
                - displayName: Value
                  units: GBP
                  index: 1
                  type: currency
                reportData:
                - dimension: 0
                  dimensionDisplayName: Period
                  item: 0
                  itemDisplayName: Period 0
                  components:
                  - dimension: 1
                    dimensionDisplayName: Order metrics
                    item: 0
                    itemDisplayName: Number of orders
                    measures:
                    - index: 0
                      measureDisplayName: Count
                      value: 94
                  - dimension: 1
                    dimensionDisplayName: Order metrics
                    item: 1
                    itemDisplayName: Total value
                    measures:
                    - index: 1
                      measureDisplayName: Value
                      value: 3315.18
                  - dimension: 1
                    dimensionDisplayName: Order metrics
                    item: 2
                    itemDisplayName: Average order value
                    measures:
                    - index: 1
                      measureDisplayName: Value
                      value: 35.27
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment-Required'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
      operationId: get-commerce-orders-report
      x-speakeasy-name-override: get-orders
      x-speakeasy-group: sales.reports
      description: "The *Get orders report* endpoint returns the number of orders, total value, and average order value for a specific company's commerce connection over one or more periods of time.\n\nThis detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. \n\n[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the order metrics.\n\n#### Response structure\n\nThe Orders report's dimensions and measures are:\n\n| Index         | Dimensions     |\n|---------------|----------------|\n|   `index` = 0 | Period         |\n|   `index` = 1 | Order metrics  |\n\n| Index         | Measures   |\n|---------------|------------|\n| `index` = 0   | Count      |\n| `index` = 1   | Value      |\n\nThe report data then combines multiple reporting dimensions and measures and outputs the value of each combination.\n"
      parameters:
      - $ref: '#/components/parameters/reportDateRequired'
      - $ref: '#/components/parameters/periodLength'
      - $ref: '#/components/parameters/numberOfPeriodsRequired'
      - $ref: '#/components/parameters/periodUnit'
      - $ref: '#/components/parameters/includeDisplayNames'
  /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/connectionId'
    get:
      summary: Get refunds report
      tags:
      - Sales
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceReport'
              example:
              - reportInfo:
                  name: refunds
                  displayName: Refunds
                dimensions:
                - index: 0
                  displayName: Period
                  type: datespan
                  items:
                  - index: 0
                    displayName: Period 0
                    start: '2022-01-01'
                    end: '2022-12-31'
                - index: 1
                  displayName: Refund metrics
                  type: string
                  items:
                  - index: 0
                    value: Number of refunds
                  - index: 1
                    value: Value of refunds
                  - index: 2
                    value: Refund rate
                measures:
                - displayName: Count
                  index: 0
                  type: int
                - displayName: Value
                  units: GBP
                  index: 1
                  type: currency
                - displayName: Percentage
                  units: '%'
                  index: 2
                  type: percentage
                reportData:
                - dimension: 0
                  dimensionDisplayName: Period
                  item: 0
                  itemDisplayName: Period 0
                  components:
                  - dimension: 1
                    dimensionDisplayName: Refund metrics
                    item: 0
                    itemDisplayName: Number of refunds
                    measures:
                    - index: 0
                      measureDisplayName: Count
                      value: 39
                  - dimension: 1
                    dimensionDisplayName: Refund metrics
                    item: 1
                    itemDisplayName: Value of refunds
                    measures:
                    - index: 1
                      measureDisplayName: Value
                      value: 642.82
                  - dimension: 1
                    dimensionDisplayName: Refund metrics
                    item: 2
                    itemDisplayName: Refund rate
                    measures:
                    - index: 2
                      measureDisplayName: Percentage
                      value: 0.41
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment-Required'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
      operationId: get-commerce-refunds-report
      x-speakeasy-name-override: get-refunds
      x-speakeasy-group: sales.reports
      description: "The *Get refunds report* endpoint returns the number and total value of refunds and the refund rate for a specific company's commerce connection over one or more periods of time.\n\nThis detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. \n\n[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the refunds metrics.\n\n#### Response structure\n\nThe Refunds report's dimensions and measures are:\n\n| Index          | Dimensions     |\n|----------------|----------------|\n| `index` = 0    | Period         |\n| `index` = 1    | Refund metrics |\n\n| Index          | Measures    |\n|----------------|------------|\n| `index` = 0    | Count      |\n| `index` = 1    | Value      |\n| `index` = 2    | Percentage |\n\nThe report data then combines multiple reporting dimensions and measures and outputs the value of each combination.\n"
      parameters:
      - $ref: '#/components/parameters/reportDateRequired'
      - $ref: '#/components/parameters/periodLength'
      - $ref: '#/components/parameters/numberOfPeriodsRequired'
      - $ref: '#/components/parameters/periodUnit'
      - $ref: '#/components/parameters/includeDisplayNames'
  /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/connectionId'
    get:
      summary: Get customer retention metrics
      tags:
      - Sales
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceReport'
              example:
              - reportInfo:
                  name: customer_retention
                  displayName: Customer Retention
                dimensions:
                - index: 0
                  displayName: Period
                  type: datespan
                  items:
                  - index: 0
                    displayName: Period 0
                    start: '2022-01-01'
                    end: '2022-12-31'
                - index: 1
                  displayName: Customer retention metrics
                  type: string
                  items:
                  - index: 0
                    value: Existing customers
                  - index: 1
                    value: New customers
                  - index: 2
                    value: Total customers
                  - index: 3
                    value: Retention rate
                  - index: 4
                    value: Repeat rate
                measures:
                - displayName: Count
                  index: 0
                  type: int
                - displayName: Percentage
                  index: 1
                  type: percentage
                reportData:
                - dimension: 0
                  dimensionDisplayName: Period
                  item: 0
                  itemDisplayName: Period 0
                  components:
                  - dimension: 1
                    dimensionDisplayName: Customer retention metrics
                    item: 0
                    itemDisplayName: Existing customers
                    measures:
                    - index: 0
                      measureDisplayName: Count
                      value: 13
                  - dimension: 1
                    dimensionDisplayName: Customer retention metrics
                    item: 1
                    itemDisplayName: New customers
                    measures:
                    - index: 0
                      measureDisplayName: Count
                      value: 47
                  - dimension: 1
                    dimensionDisplayName: Customer retention metrics
                    item: 2
                    itemDisplayName: Total customers
                    measures:
                    - index: 0
                      measureDisplayName: Count
                      value: 60
                  - dimension: 1
                    dimensionDisplayName: Customer retention metrics
                    item: 3
                    itemDisplayName: Retention rate
                    measures:
                    - index: 1
                      measureDisplayName: Percentage
                      value: 0
                  - dimension: 1
                    dimensionDisplayName: Customer retention metrics
                    item: 4
                    itemDisplayName: Repeat rate
                    measures:
                    - index: 1
                      measureDisplayName: Percentage
                      value: 21.67
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment-Required'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
      operationId: get-commerce-customer-retention-metrics
      x-speakeasy-name-override: get-customer-retention
      x-speakeasy-group: sales.metrics
      description: "The *Get customer retention metrics* endpoint returns customer retention insights for a specific company's commerce connection over one or more periods of time.\n\nThis detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. \n\n#### Customer retention metrics\n\n- __Existing customers__: the number of unique customers that have placed an order(s) in the specified period and any previous period. \n- __New customers__: the number of unique customers that have placed an order(s) in the specified period and none in any previous period.\n- __Total customers__: the total number of existing and new customers within the specified period.\n- __Retention rate__: the ratio of existing customers within the specified period compared to the total customers at the end of the previous period represented as a percentage.\n- __Repeat rate__: the ratio of existing customers to total customers over the specified period represented as a percentage.\n\n[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate customer retention metrics.\n\n#### Response structure\n\nThe Customer retention report's dimensions and measures are:\n\n| Index                       | Dimensions                 |\n|-----------------------------|----------------------------|\n| `index` = 0                 | Period                     |\n| `index` = 1                 | Customer retention metrics |\n\n| Index                | Measures    |\n|----------------------|------------|\n| `index` = 0          | Count      |\n| `index` = 1          | Percentage |\n\nThe report data then combines multiple reporting dimensions and measures and outputs the value of each combination."
      parameters:
      - $ref: '#/components/parameters/reportDateRequired'
      - $ref: '#/components/parameters/periodLength'
      - $ref: '#/components/parameters/numberOfPeriodsRequired'
      - $ref: '#/components/parameters/periodUnit'
      - $ref: '#/components/parameters/includeDisplayNames'
  /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/connectionId'
    get:
      summary: Get lifetime value metrics
      tags:
      - Sales
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceReport'
              example:
              - reportInfo:
                  name: lifetime_value
                  displayName: Lifetime Value
                dimensions:
                - index: 0
                  displayName: Period
                  type: datespan
                  items:
                  - index: 0
                    displayName: Period 0
                    start: '2022-01-01'
                    end: '2022-12-31'
                - index: 1
                  displayName: Lifetime value metrics
                  type: string
                  items:
                  - index: 0
                    value: Lifetime value
                measures:
                - displayName: Value
                  units: GBP
                  index: 0
                  type: currency
                reportData:
                - dimension: 0
                  dimensionDisplayName: Period
                  item: 0
                  itemDisplayName: Period 0
                  components:
                  - dimension: 1
                    dimensionDisplayName: Lifetime value metrics
                    item: 0
                    itemDisplayName: Lifetime value
                    measures:
                    - index: 0
                      measureDisplayName: Value
                      value: 3782.07
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/Payment-Required'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
      operationId: get-commerce-lifetime-value-metrics
      x-speakeasy-name-override: get-lifetime-value
      x-speakeasy-group: sales.metrics
      description: 'The *Get lifetime value metrics* endpoint returns the average revenue that a specific company will generate throughout its lifespan over one or more periods of time.


        This detail helps you assess a merchant''s health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.


        [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the lifetime value metrics.


        #### Response structure


        The Lifetime value report''s dimensions and measures are:


        | Index         | Dimensions             |

        |---------------|------------------------|

        | `index` = 0   | Period                 |

        | `index` = 1   | Lifetime value metrics |


        | Index             | Measures |

        |-------------------|---------|

        |   `index` = 1     | Value   |


        The report data then combines multiple reporting dimensions and measures and outputs the value of each combination.

        '
      parameters:
      - $ref: '#/components/parameters/reportDateRequired'
      - $ref: '#/components/parameters/periodLength'
      - $ref: '#/components/parameters/numberOfPeriodsRequired'
      - $ref: '#/components/parameters/periodUnit'
      - $ref: '#/components/parameters/includeDisplayNames'
  /companies/{companyId}/connections/{connectionId}/data/commerce-customers:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/connectionId'
    get:
      tags:
      - Sales
      summary: List customers
      operationId: list-commerce-customers
      x-speakeasy-group: sales.customers
      description: "The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and recieve goods and/or services from the SMB.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n    "
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/query'
      - $ref: '#/components/parameters/orderBy'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceCustomers'
              examples:
                BigCommerce:
                  value:
                    results:
                    - id: '1'
                      customerName: Amy Jones
                      emailAddress: a.jackson@email.me
                      defaultCurrency: XXX
                      phone: 07770 666777
                      addresses:
                      - type: Unknown
                        line1: My Billing Address ./*drop table
                        city: Portsmouth
                        region: ''
                        country: United Kingdom
                        postalCode: PS13HJ
                      - type: Unknown
                        line1: This is my address, I cant hit enter.
                        city: Portsmouth
                        region: ''
                        country: United Kingdom
                        postalCode: PS13HJ
                      createdDate: '2022-06-15T15:54:15Z'
                      modifiedDate: '2023-04-11T10:33:49Z'
                      sourceModifiedDate: '2022-06-15T15:54:15Z'
                    - id: '2'
                      customerName: Cust001 Cust001
                      emailAddress: Cust001@example.com
                      defaultCurrency: XXX
                      phone: 05442 203941
                      addresses: []
                      createdDate: '2023-04-11T15:49:25Z'
                      modifiedDate: '2023-04-17T15:42:55Z'
                      sourceModifiedDate: '2023-04-11T15:49:25Z'
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 201
                    _links:
                      current:
                        href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers?page=1&pageSize=2
                      self:
                        href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers
                      next:
                        href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers?page=2&pageSize=2
                Clover:
                  value:
                    results:
                    - id: 2CBJ8R898ZJAR
                      customerName: ''
                      addresses: []
                      createdDate: '2021-09-22T13:10:12Z'
                      modifiedDate: '2023-01-09T11:01:03Z'
                      sourceModifiedDate: '0001-01-01T00:00:00'
                    - id: 511JV0FRN2QYC
                      customerName: ''
                      addresses: []
                      createdDate: '2021-09-21T14:54:38Z'
                      modifiedDate: '2023-01-09T11:01:03Z'
                      sourceModifiedDate: '0001-01-01T00:00:00'
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 9
                    _links:
                      current:
                        href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers?page=1&pageSize=2
                      self:
                        href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers
                      next:
                        href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers?page=2&pageSize=2
                Mollie:
                  value:
                    results:
                    - id: cst_NUkBHQmekz
                      customerName: Frod Baggins
                      emailAddress: frodo.baggings@theshire.com
                      addresses: []
                      createdDate: '2022-01-18T11:41:54'
                      modifiedDate: '2022-03-17T15:47:28Z'
                    - id: cst_BvBxwuwfvH
                      customerName: Frodo Baggins
                      emailAddress: frodo.baggings@theshire.com
                      addresses: []
                      createdDate: '2022-01-18T11:42:05'
                      modifiedDate: '2022-03-17T15:47:28Z'
                    pageNumber: 1
                    pageSize: 2
                    totalResults: 3
                    _links:
                      current:
                        href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers?page=1&pageSize=2
                      self:
                        href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers
                      next:
                        href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers?page=2&pageSize=2
                Mollie Test:
                  value:
                    results:
                    - id: cst_NUkBHQmekz
                      customerName: Frod Baggins
                      emailAddress: frodo.baggings@theshire.com
                      addresses: []
                      createdDate: '2022-01-18T11:41:54'
                      modifiedDate: '2022-08-17T11:33:19Z'
                    - id: cst_BvBxwuwfvH
                      customerName: Frodo Baggins
                      emailAddress: frodo.baggings@theshire.com
           

# --- truncated at 32 KB (327 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codat/refs/heads/main/openapi/codat-sales-api-openapi.yml