Dotdigital

Dotdigital Ecommerce API

The Ecommerce API from Dotdigital — 1 operation(s) for ecommerce.

GitHub OpenAPI

Operations 1

GET /v2/ecommerce/orders Get orders since 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-ecommerce-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-ecommerce-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-ecommerce-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ecommerce API
  description: 'Deprecated v2 endpoint for retrieving ecommerce order records by date. Use this

    API to retrieve a paginated list of orders since a specified date, including line

    items, pricing totals, delivery and billing addresses, payment method, and coupon

    codes. New integrations should use the Insight Data Service API instead.'
  version: 2.0.1
servers:
- url: https://{region}-api.dotdigital.com
  variables:
    region:
      default: r1
      enum:
      - r1
      - r2
      - r3
      description: The Dotdigital region id your account belongs to
security:
- basicAuth: []
tags:
- name: Ecommerce
paths:
  /v2/ecommerce/orders:
    get:
      summary: Get orders since date
      description: Gets a list of all orders since a specified date.
      operationId: get-orders-since-date
      deprecated: true
      tags:
      - Ecommerce
      parameters:
      - name: fromDate
        in: query
        description: The date from which any orders are returned in [ISO 8601 format](https://www.w3.org/TR/xmlschema-2/#dateTime), note the time component is ignored — only the date part is used.
        required: true
        schema:
          type: string
          format: date
      - name: select
        in: query
        description: The number of records to select between 1 and 1000 to retrieve.
        required: false
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 1000
          default: 1000
      - name: skip
        in: query
        description: The numbers of records to skip in the result set.
        required: false
        schema:
          type: integer
          minimum: 1
          format: int32
      responses:
        '200':
          description: A list of orders matching the specified date range.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The unique identifier of the order.
                    email:
                      type: string
                      description: 'The email address of the contact who placed the order. Returns a placeholder string if the contact has been deleted.

                        '
                    contactId:
                      type: string
                      description: The ID of the contact who placed the order.
                    items:
                      type: array
                      items:
                        type: object
                        properties:
                          sku:
                            type: string
                            description: The SKU of the product.
                          name:
                            type: string
                            description: The name of the product.
                          price:
                            type: number
                            format: decimal
                            description: The unit price of the product.
                          quantity:
                            type: number
                            format: decimal
                            description: The quantity ordered.
                          imagePath:
                            type: string
                            description: The URL or path to the product image.
                      description: The line items included in the order.
                    orderTotal:
                      type: number
                      format: decimal
                      description: The total value of the order.
                    orderDate:
                      type: string
                      format: date-time
                      description: The UTC date and time the order was placed.
                    subtotal:
                      type: number
                      format: decimal
                      description: The order subtotal before tax and delivery.
                    payment:
                      type: string
                      description: The payment method used for the order.
                    status:
                      type: string
                      description: The current status of the order.
                    discount:
                      type: number
                      format: decimal
                      description: The total discount applied to the order.
                    deliveryTotal:
                      type: number
                      format: decimal
                      description: The total delivery cost.
                    deliveryMethod:
                      type: string
                      description: The delivery method chosen for the order.
                    deliveryAddress:
                      type: object
                      properties:
                        address1:
                          type: string
                          description: The first line of the address.
                        address2:
                          type: string
                          description: The second line of the address.
                        city:
                          type: string
                          description: The city.
                        country:
                          type: string
                          description: The country.
                        postCode:
                          type: string
                          description: The postal code.
                    currency:
                      type: string
                      description: The ISO 4217 currency code for the order.
                    billingAddress:
                      type: object
                      properties:
                        address1:
                          type: string
                          description: The first line of the address.
                        address2:
                          type: string
                          description: The second line of the address.
                        city:
                          type: string
                          description: The city.
                        country:
                          type: string
                          description: The country.
                        postCode:
                          type: string
                          description: The postal code.
                    baseSubtotalInclTax:
                      type: number
                      format: decimal
                      description: The base subtotal including tax.
                    couponCode:
                      type: string
                      description: Any coupon code applied to the order.
                    quoteId:
                      type: string
                      description: The quote ID associated with the order.
                    retailValue:
                      type: number
                      format: decimal
                      description: The retail value of the order.
              examples:
                Result:
                  summary: Result
                  value:
                  - id: '200273'
                    email: christine.olson@emailsim.io
                    contactId: '14544'
                    items:
                    - sku: wedze-all-mountain-xlander-900-downhill-skiing-skis-blue
                      name: WED'ZE ALL MOUNTAIN XLANDER 900 DOWNHILL SKIING SKIS - BLUE
                      price: 259.99
                      quantity: 1
                      imagePath: null
                    orderTotal: 2056.6375
                    orderDate: '2022-08-01 05:42:00+00:00'
                    subtotal: 1645.31
                    payment: null
                    status: null
                    discount: 456616
                    deliveryTotal: 144284
                    deliveryMethod: post
                    deliveryAddress:
                      address1: ''
                      address2: ''
                      city: ''
                      country: ''
                      postCode: ''
                    currency: EUR
                    billingAddress:
                      address1: ''
                      address2: ''
                      city: ''
                      country: ''
                      postCode: ''
                    baseSubtotalInclTax: 295822
                    couponCode: null
                    quoteId: '727036'
                    retailValue: 1727.316363675
        '400':
          description: 'Invalid paging parameters (`ERROR_PARAMETER_INVALID`). `select` must be between 1 and 1000. `skip` must not be negative.

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: A description of the error.
        '401':
          description: Invalid or missing credentials.
        '403':
          description: The ecommerce feature is not active on this account (`ERROR_FEATURENOTACTIVE`).
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: A description of the error.
              example:
                message: 'Error: ERROR_FEATURENOTACTIVE'
        '404':
          description: No orders collection exists for this account (`ERROR_TRANSACTIONAL_DATA_COLLECTION_DOES_NOT_EXIST`).
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: A description of the error.
              example:
                message: 'Error: ERROR_TRANSACTIONAL_DATA_COLLECTION_DOES_NOT_EXIST'
        '503':
          description: The orders collection is currently being restored (`ERROR_TRANSACTIONAL_DATA_COLLECTION_IS_RESTORING`).
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: A description of the error.
              example:
                message: 'Error: ERROR_TRANSACTIONAL_DATA_COLLECTION_IS_RESTORING'
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Learn more about Dotdigital APIs
  url: https://developer.dotdigital.com
x-readme:
  headers: []
  explorer-enabled: true
  proxy-enabled: true
x-readme-fauxas: true
x-samples-languages:
- curl
- csharp
- java
- javascript
- node
- python
- php
- ruby