Data Contract

urn:datacontract:checkout:orders-latest-nested

Info

Information about the data contract

Title
Orders Latest (Nested)
Version
1.0.0
Description
Successful customer orders in the webshop. All orders since 2020-01-01. Orders with their line items are in their current state (no history included).
Owner
Checkout Team
Contact
John Doe (Data Product Owner)

Terms

Terms and conditions of the data contract

Usage
Data can be used for reports, analytics and machine learning use cases. Order may be linked and joined by other tables
Limitations
Not suitable for real-time use cases. Data may not be used to identify individual customers. Max data processing per day: 10 TiB
Billing
5000 USD per month
Notice Period
P3M

Data Model

The logical data model

orders table
One record per order. Includes cancelled and deleted orders.
Order ID
order_id
text
An internal ID that identifies an order in the online shop.
Example: 243c25e5-a081-43a9-aeab-6d5d5b6cb5e2
primary required unique format:uuid restricted PII
order_timestamp
timestamp
The business timestamp in UTC when the order was successfully registered in the source system and the payment was successful.
required
order_total
long
Total amount the smallest monetary unit (e.g., cents).
required
customer_id
text
Unique identifier for the customer.
minLength:10 maxLength:20
customer_email_address
text
The email address, as entered by the customer. The email address was not verified.
required format:email
address
object
The delivery address of the customer.
 
↳
street
text
The street name and house number.
 
↳
city
text
The city name.
 
↳
additional_lines
array
Additional address lines, such as floor, apartment, or company name.
processed_timestamp
timestamp
The timestamp when the record was processed by the data platform.
required
line_items table
A single article that is part of an order.
lines_item_id
text
Primary key of the lines_item_id table
primary required unique
Order ID
order_id
text
An internal ID that identifies an order in the online shop.
Example: 243c25e5-a081-43a9-aeab-6d5d5b6cb5e2
format:uuid restricted PII
Stock Keeping Unit
sku
text
The purchased article number
Example: 96385074
pattern:^[A-Za-z0-9]{8,14}$

Definitions

Domain specific definitions in the data contract

order_id checkout
An internal ID that identifies an order in the online shop.
Order ID
order_id
text uuid
Example: 243c25e5-a081-43a9-aeab-6d5d5b6cb5e2
restricted PII
sku inventory
A Stock Keeping Unit (SKU) is an internal unique identifier for an article. It is typically associated with an article's barcode, such as the EAN/GTIN.
Stock Keeping Unit
sku
text
Example: 96385074
pattern:^[A-Za-z0-9]{8,14}$
Created at 27 Jun 2024 14:50:06 UTC with Data Contract CLI v0.10.8

Data Contract YAML

dataContractSpecification: 0.9.3
id: urn:datacontract:checkout:orders-latest-nested
info:
  title: Orders Latest (Nested)
  version: 1.0.0
  description: "Successful customer orders in the webshop. \nAll orders since 2020-01-01.\
    \ \nOrders with their line items are in their current state (no history included).\n"
  owner: Checkout Team
  contact:
    name: John Doe (Data Product Owner)
    url: https://teams.microsoft.com/l/channel/example/checkout
terms:
  usage: 'Data can be used for reports, analytics and machine learning use cases.

    Order may be linked and joined by other tables

    '
  limitations: 'Not suitable for real-time use cases.

    Data may not be used to identify individual customers.

    Max data processing per day: 10 TiB

    '
  billing: 5000 USD per month
  noticePeriod: P3M
models:
  orders:
    description: One record per order. Includes cancelled and deleted orders.
    type: table
    fields:
      order_id:
        ref: '#/definitions/order_id'
        title: Order ID
        type: text
        format: uuid
        required: true
        primary: true
        unique: true
        description: An internal ID that identifies an order in the online shop.
        pii: true
        classification: restricted
        example: 243c25e5-a081-43a9-aeab-6d5d5b6cb5e2
      order_timestamp:
        type: timestamp
        required: true
        primary: false
        unique: false
        description: The business timestamp in UTC when the order was successfully
          registered in the source system and the payment was successful.
      order_total:
        type: long
        required: true
        primary: false
        unique: false
        description: Total amount the smallest monetary unit (e.g., cents).
      customer_id:
        type: text
        required: false
        primary: false
        unique: false
        description: Unique identifier for the customer.
        minLength: 10
        maxLength: 20
      customer_email_address:
        type: text
        format: email
        required: true
        primary: false
        unique: false
        description: The email address, as entered by the customer. The email address
          was not verified.
      address:
        type: object
        required: false
        primary: false
        unique: false
        description: The delivery address of the customer.
        fields:
          street:
            type: text
            required: false
            primary: false
            unique: false
            description: The street name and house number.
          city:
            type: text
            required: false
            primary: false
            unique: false
            description: The city name.
          additional_lines:
            type: array
            required: false
            primary: false
            unique: false
            description: Additional address lines, such as floor, apartment, or company
              name.
            items:
              type: text
              required: false
              primary: false
              unique: false
              description: Additional line
      processed_timestamp:
        type: timestamp
        required: true
        primary: false
        unique: false
        description: The timestamp when the record was processed by the data platform.
  line_items:
    description: A single article that is part of an order.
    type: table
    fields:
      lines_item_id:
        type: text
        required: true
        primary: true
        unique: true
        description: Primary key of the lines_item_id table
      order_id:
        ref: '#/definitions/order_id'
        title: Order ID
        type: text
        format: uuid
        required: false
        primary: false
        unique: false
        references: orders.order_id
        description: An internal ID that identifies an order in the online shop.
        pii: true
        classification: restricted
        example: 243c25e5-a081-43a9-aeab-6d5d5b6cb5e2
      sku:
        ref: '#/definitions/sku'
        title: Stock Keeping Unit
        type: text
        required: false
        primary: false
        unique: false
        description: The purchased article number
        pattern: ^[A-Za-z0-9]{8,14}$
        example: '96385074'
definitions:
  order_id:
    domain: checkout
    name: order_id
    title: Order ID
    description: An internal ID that identifies an order in the online shop.
    type: text
    format: uuid
    pii: true
    classification: restricted
    example: 243c25e5-a081-43a9-aeab-6d5d5b6cb5e2
  sku:
    domain: inventory
    name: sku
    title: Stock Keeping Unit
    description: "A Stock Keeping Unit (SKU) is an internal unique identifier for\
      \ an article. \nIt is typically associated with an article's barcode, such as\
      \ the EAN/GTIN.\n"
    type: text
    pattern: ^[A-Za-z0-9]{8,14}$
    example: '96385074'