openapi: 3.1.0 info: title: Ecommerce 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 x-readme: headers: [] explorer-enabled: true proxy-enabled: true x-readme-fauxas: true x-samples-languages: - curl - csharp - java - javascript - node - python - php - ruby externalDocs: description: Learn more about Dotdigital APIs url: https://developer.dotdigital.com 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: [] 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 schemas: ApiOrder: 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. ApiOrderItem: 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. ApiOrderAddress: 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. ApiError: type: object properties: message: type: string description: A description of the error.