Dotdigital

Dotdigital API Ecommerce API

The ApiEcommerce API from Dotdigital — 4 operation(s) for apiecommerce.

GitHub OpenAPI

Operations 5

GET /v2/ecommerce/summaries Returns the Retail KPI summaries for the specified date range. #
POST /v2/ecommerce/summaries Requests a refreshing of metric data. #
GET /v2/ecommerce/fullsummary Returns Retail KPI summaries across every data range. #
GET /v2/ecommerce/summary/{summaryType} Gets a KPI metric of a specified type over a specified date range. #
GET /v2/ecommerce/orders Gets a list of all orders since a date. #

Documentation

📖
Documentation
https://marketing.developer.dotdigital.com/docs/getting-started-with-the-api
📖
APIReference
https://marketing.developer.dotdigital.com/reference/
📖
Documentation
https://marketing.developer.dotdigital.com/docs/api-end-points
📖
APIReference
https://marketing.developer.dotdigital.com/reference/unified-contacts
📖
Documentation
https://marketing.developer.dotdigital.com/reference/omnichannel-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dotdigital/refs/heads/main/openapi/dotdigital-apiecommerce-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/dotdigital-apiecommerce-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dotdigital-apiecommerce-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: apiconnector.com API Ecommerce API
  version: v2
servers:
- url: https://r1-api.dotdigital.com
tags:
- name: ApiEcommerce
paths:
  /v2/ecommerce/summaries:
    get:
      tags:
      - ApiEcommerce
      summary: Returns the Retail KPI summaries for the specified date range.
      operationId: ApiEcommerce_GetKpiMetricSummaries
      parameters:
      - name: dateRange
        in: query
        schema:
          $ref: '#/components/schemas/ApiKpiMetricDateRange'
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportSummaryOfKpiMetricSummary'
    post:
      tags:
      - ApiEcommerce
      summary: Requests a refreshing of metric data.
      operationId: ApiEcommerce_RefreshSummaries
      responses:
        '200':
          description: ''
  /v2/ecommerce/fullsummary:
    get:
      tags:
      - ApiEcommerce
      summary: Returns Retail KPI summaries across every data range.
      operationId: ApiEcommerce_GetAllKpiMetricSummaries
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportSummaryOfKpiMetricSummary'
  /v2/ecommerce/summary/{summaryType}:
    get:
      tags:
      - ApiEcommerce
      summary: Gets a KPI metric of a specified type over a specified date range.
      operationId: ApiEcommerce_GetMetricSummary
      parameters:
      - name: dateRange
        in: query
        schema:
          $ref: '#/components/schemas/ApiKpiMetricDateRange'
        x-position: 1
      - name: summaryType
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/ApiKpiMetricType'
        x-position: 2
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportSummaryOfKpiMetricSummary'
  /v2/ecommerce/orders:
    get:
      tags:
      - ApiEcommerce
      summary: Gets a list of all orders since a date.
      operationId: ApiEcommerce_GetTransactionalDataByCollectionFromIdFromDate
      parameters:
      - name: fromDate
        in: query
        schema:
          type: string
          format: date-time
        x-position: 1
      - name: select
        in: query
        schema:
          type: integer
          format: int32
          default: 1000
        x-position: 2
      - name: skip
        in: query
        schema:
          type: integer
          format: int32
          default: 0
        x-position: 3
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiOrder'
components:
  schemas:
    ApiOrder:
      type: object
      additionalProperties: false
      properties:
        id:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
        contactId:
          type:
          - string
          - 'null'
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ApiOrderItem'
        orderTotal:
          type: number
          format: decimal
        orderDate:
          type: string
          format: date-time
        subtotal:
          type: number
          format: decimal
        payment:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        discount:
          type: number
          format: decimal
        deliveryTotal:
          type: number
          format: decimal
        deliveryMethod:
          type:
          - string
          - 'null'
        deliveryAddress:
          oneOf:
          - $ref: '#/components/schemas/ApiOrderAddress'
        currency:
          type:
          - string
          - 'null'
        billingAddress:
          oneOf:
          - $ref: '#/components/schemas/ApiOrderAddress'
        baseSubtotalInclTax:
          type: number
          format: decimal
        couponCode:
          type:
          - string
          - 'null'
        quoteId:
          type:
          - string
          - 'null'
        retailValue:
          type: number
          format: decimal
    ReportSummaryOfKpiMetricSummary:
      type: object
      additionalProperties: false
      properties:
        records:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/KpiMetricSummary'
        dateRange:
          oneOf:
          - $ref: '#/components/schemas/EcommercePredefinedDateRanges'
        asOfDate:
          type: string
          format: date-time
    KpiMetricSummary:
      type: object
      additionalProperties: false
      properties:
        metricType:
          $ref: '#/components/schemas/KpiMetricType'
        metricValues:
          oneOf:
          - $ref: '#/components/schemas/KpiMetricValue'
        dateRange:
          $ref: '#/components/schemas/EcommercePredefinedDateRanges'
    EcommercePredefinedDateRanges:
      type: string
      description: ''
      x-enumNames:
      - LastThirtyVsPrevious
      - TodayVsYesterday
      - YesterdayVsPrevious
      - ThisWeekVsLast
      - LastWeekVsPrevious
      - ThisMonthVsLast
      - LastMonthVsPrevious
      - ThisYearVsLast
      - LastYearVsPrevious
      - AllTime
      - Custom
      enum:
      - LastThirtyVsPrevious
      - TodayVsYesterday
      - YesterdayVsPrevious
      - ThisWeekVsLast
      - LastWeekVsPrevious
      - ThisMonthVsLast
      - LastMonthVsPrevious
      - ThisYearVsLast
      - LastYearVsPrevious
      - AllTime
      - Custom
    KpiMetricType:
      type: string
      description: ''
      x-enumNames:
      - TotalRevenue
      - AverageOrderValue
      - CustomerLifetimeValue
      - TotalOrders
      - AverageItemsPerOrder
      - AverageDaysToSecondOrder
      - Customers
      - SinglePurchaseCustomers
      - RepeatCustomers
      - TotalDelay
      - TotalRepeatOrders
      - TotalItems
      enum:
      - TotalRevenue
      - AverageOrderValue
      - CustomerLifetimeValue
      - TotalOrders
      - AverageItemsPerOrder
      - AverageDaysToSecondOrder
      - Customers
      - SinglePurchaseCustomers
      - RepeatCustomers
      - TotalDelay
      - TotalRepeatOrders
      - TotalItems
    KpiMetricValue:
      type: object
      additionalProperties: false
      properties:
        initialTotalValue:
          type: number
          format: double
        comparisonTotalValue:
          type: number
          format: double
    ApiKpiMetricDateRange:
      type: string
      description: ''
      x-enumNames:
      - LastThirtyVsPrevious
      - TodayVsYesterday
      - YesterdayVsPrevious
      - ThisWeekVsLast
      - LastWeekVsPrevious
      - ThisMonthVsLast
      - LastMonthVsPrevious
      - ThisYearVsLast
      - LastYearVsPrevious
      - AllTime
      - NotAvailableInThisVersion
      enum:
      - LastThirtyVsPrevious
      - TodayVsYesterday
      - YesterdayVsPrevious
      - ThisWeekVsLast
      - LastWeekVsPrevious
      - ThisMonthVsLast
      - LastMonthVsPrevious
      - ThisYearVsLast
      - LastYearVsPrevious
      - AllTime
      - NotAvailableInThisVersion
    ApiKpiMetricType:
      type: string
      description: ''
      x-enumNames:
      - TotalRevenue
      - AverageOrderValue
      - CustomerLifetimeValue
      - TotalOrders
      - AverageItemsPerOrder
      - AverageDaysToSecondOrder
      - Customers
      - SinglePurchaseCustomers
      - RepeatCustomers
      - NotAvailableInThisVersion
      enum:
      - TotalRevenue
      - AverageOrderValue
      - CustomerLifetimeValue
      - TotalOrders
      - AverageItemsPerOrder
      - AverageDaysToSecondOrder
      - Customers
      - SinglePurchaseCustomers
      - RepeatCustomers
      - NotAvailableInThisVersion
    ApiOrderAddress:
      type: object
      additionalProperties: false
      properties:
        address1:
          type:
          - string
          - 'null'
        address2:
          type:
          - string
          - 'null'
        city:
          type:
          - string
          - 'null'
        country:
          type:
          - string
          - 'null'
        postCode:
          type:
          - string
          - 'null'
    ApiOrderItem:
      type: object
      additionalProperties: false
      properties:
        sku:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        price:
          type: number
          format: decimal
        quantity:
          type: number
          format: decimal
        imagePath:
          type:
          - string
          - 'null'
x-generator: NSwag v14.4.0.0 (NJsonSchema v11.3.2.0 (Newtonsoft.Json v13.0.0.0))