---
updatedAt: 2025-05-14T00:15:40.000Z
agentTools:
  projectIndex: https://docs.ometria.com/llms.txt
---

# Transactional API data sets

We recommend using the following schema to name your data parameters.

## Contact

### Array - contact

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Value
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `email`
      </td>

      <td>
        The contact's email address.
      </td>

      <td>
        [jane@fashionshop.com](mailto:jane@fashionshop.com)
      </td>
    </tr>

    <tr>
      <td>
        `phone`
      </td>

      <td>
        The contact's phone number.
      </td>

      <td>
        07712312334
      </td>
    </tr>

    <tr>
      <td>
        `title`
      </td>

      <td>
        The contact's title.
      </td>

      <td>
        Ms
      </td>
    </tr>

    <tr>
      <td>
        `name`
      </td>

      <td>
        The contact's first and last name.
      </td>

      <td>
        Jane Smith
      </td>
    </tr>

    <tr>
      <td>
        `firstname`
      </td>

      <td>
        The contact's first name.
      </td>

      <td>
        Jane
      </td>
    </tr>

    <tr>
      <td>
        `surname`
      </td>

      <td>
        The contact's last name.
      </td>

      <td>
        Smith
      </td>
    </tr>

    <tr>
      <td>
        `contactID`
      </td>

      <td>
        The contact's ID.
      </td>

      <td>
        1234
      </td>
    </tr>

    <tr>
      <td>
        `accountURL`
      </td>

      <td>
        The URL to access the contact's account settings.
      </td>

      <td>
        [www.fashionshop.com/myacc](http://www.fashionshop.com/myacc)\
        ount/12345
      </td>
    </tr>
  </tbody>
</Table>

## Order

### Array - details

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Value
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `orderID`
      </td>

      <td>
        The ID of the order placed.
      </td>

      <td>
        00002501
      </td>
    </tr>

    <tr>
      <td>
        `creationDate`
      </td>

      <td>
        The date and time the order was placed.
      </td>

      <td>
        01/16/2019 9:50 am
      </td>
    </tr>

    <tr>
      <td>
        `status`
      </td>

      <td>
        The status of the order.
      </td>

      <td>
        New
      </td>
    </tr>

    <tr>
      <td>
        `orderDetailsURL`
      </td>

      <td>
        A link direct to the order details.
      </td>

      <td>
        [www.fashionshop.com/brand/orders](http://www.fashionshop.com/brand/orders)
      </td>
    </tr>

    <tr>
      <td>
        `coupons`
      </td>

      <td>
        Any coupon code(s) used in the order.
      </td>

      <td>
        Welcome10
      </td>
    </tr>
  </tbody>
</Table>

### Array - payment

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Value
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `paymentMethod`
      </td>

      <td>
        The method of payment used in the order.
      </td>

      <td>
        Credit Card
      </td>
    </tr>

    <tr>
      <td>
        `lastFour`
      </td>

      <td>
        The last four digits on the credit card used in the order.
      </td>

      <td>
        1234
      </td>
    </tr>

    <tr>
      <td>
        `amount`
      </td>

      <td>
        The monetary amount paid.
      </td>

      <td>
        £1530
      </td>
    </tr>
  </tbody>
</Table>

### Array - totals

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Value
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `subTotal`
      </td>

      <td>
        The subtotal for the order excluding shipping and tax.
      </td>

      <td>
        £1530
      </td>
    </tr>

    <tr>
      <td>
        'totalShippingCost'
      </td>

      <td>
        The shipping cost for the order.
      </td>

      <td>
        £5
      </td>
    </tr>

    <tr>
      <td>
        `totalTax`
      </td>

      <td>
        The tax cost for the order.
      </td>

      <td>
        £5
      </td>
    </tr>

    <tr>
      <td>
        `grandTotal`
      </td>

      <td>
        The total for the order including\
        shipping and tax.
      </td>

      <td>
        £1535
      </td>
    </tr>
  </tbody>
</Table>

### Array - shipping

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Value
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `address1 `
      </td>

      <td>
        The first line of the shipping address.
      </td>

      <td>
        1 Example Road
      </td>
    </tr>

    <tr>
      <td>
        `address2`
      </td>

      <td>
        The second line of the shipping address.
      </td>

      <td>
        West Quarter
      </td>
    </tr>

    <tr>
      <td>
        `address3`
      </td>

      <td>
        The third line of the shipping address.
      </td>

      <td>
        Townsville
      </td>
    </tr>

    <tr>
      <td>
        `city`
      </td>

      <td>
        The city of the shipping address.
      </td>

      <td>
        London
      </td>
    </tr>

    <tr>
      <td>
        `county`
      </td>

      <td>
        The state or county of the shipping address.
      </td>

      <td>
        Greater London
      </td>
    </tr>

    <tr>
      <td>
        `postcode`
      </td>

      <td>
        The shipping address postcode or zip code.
      </td>

      <td>
        EC1 1HY
      </td>
    </tr>

    <tr>
      <td>
        `countrycode`
      </td>

      <td>
        The shipping address country code.
      </td>

      <td>
        GB
      </td>
    </tr>

    <tr>
      <td>
        `trackingID`
      </td>

      <td>
        The ID of the tracking service.
      </td>

      <td>
        1223
      </td>
    </tr>

    <tr>
      <td>
        `trackingURL`
      </td>

      <td>
        The URL of the tracking service.
      </td>

      <td>
        [www.ometria.com/trackin](http://www.ometria.com/trackin)\
        g/1223
      </td>
    </tr>
  </tbody>
</Table>

### Array - billing

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Value
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `address1`
      </td>

      <td>
        The first line of the billing address.
      </td>

      <td>
        1 Example Road
      </td>
    </tr>

    <tr>
      <td>
        `address2`
      </td>

      <td>
        The second line of the billing address.
      </td>

      <td>
        West Quarter
      </td>
    </tr>

    <tr>
      <td>
        `address3`
      </td>

      <td>
        The third line of the billing address.
      </td>

      <td>
        Townsville
      </td>
    </tr>

    <tr>
      <td>
        `city`
      </td>

      <td>
        The city of the billing address.
      </td>

      <td>
        London
      </td>
    </tr>

    <tr>
      <td>
        `county`
      </td>

      <td>
        The state or county of the billing address.
      </td>

      <td>
        Greater London
      </td>
    </tr>

    <tr>
      <td>
        `postcode`
      </td>

      <td>
        The billing address postcode or zip code.
      </td>

      <td>
        EC1 1HY
      </td>
    </tr>

    <tr>
      <td>
        `countrycode`
      </td>

      <td>
        The shipping address country code.
      </td>

      <td>
        GB
      </td>
    </tr>
  </tbody>
</Table>

### Array - items

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Value
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `imgUrl`
      </td>

      <td>
        The product image URL.
      </td>

      <td>
        [https://www.ometria.com/](https://www.ometria.com/)\
        img/12243563.jpg
      </td>
    </tr>

    <tr>
      <td>
        `productID`
      </td>

      <td>
        The product's ID.
      </td>

      <td>
        12243563
      </td>
    </tr>

    <tr>
      <td>
        `colour`
      </td>

      <td>
        The product's colour.
      </td>

      <td>
        Green
      </td>
    </tr>

    <tr>
      <td>
        `url`
      </td>

      <td>
        The URL of the product on your website.
      </td>

      <td>
        [https://www.ometria.com/](https://www.ometria.com/)\
        product/12243563.html
      </td>
    </tr>

    <tr>
      <td>
        `quantity`
      </td>

      <td>
        The quantity of the products purchased, refunded or added to wishlist.
      </td>

      <td>
        1
      </td>
    </tr>

    <tr>
      <td>
        `sizeName`
      </td>

      <td>
        The product size.
      </td>

      <td>
        12
      </td>
    </tr>

    <tr>
      <td>
        `sizeDescription`
      </td>

      <td>
        A description of the product size.
      </td>

      <td>
        UK size 12 Trousers.
      </td>
    </tr>

    <tr>
      <td>
        `price`
      </td>

      <td>
        The product price.
      </td>

      <td>
        £25.00
      </td>
    </tr>

    <tr>
      <td>
        `discount`
      </td>

      <td>
        Any discount applied to the order.
      </td>

      <td>
        £10
      </td>
    </tr>

    <tr>
      <td>
        `subTotal`
      </td>

      <td>
        The price of the product multiplied by the quantity.
      </td>

      <td>
        £25.00
      </td>
    </tr>

    <tr>
      <td>
        `length`
      </td>

      <td>
        The product length.
      </td>

      <td>
        Short.
      </td>
    </tr>

    <tr>
      <td>
        `productName`
      </td>

      <td>
        The product name.
      </td>

      <td>
        Green trousers.
      </td>
    </tr>

    <tr>
      <td>
        `sku`
      </td>

      <td>
        The product SKU.
      </td>

      <td>
        green\_trousers
      </td>
    </tr>
  </tbody>
</Table>

## Review

### Array - review

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Value
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `token`
      </td>

      <td>
        The URL for submitting the review.
      </td>

      <td>
        [www.ometria.com/review](http://www.ometria.com/review)\
        /12345
      </td>
    </tr>

    <tr>
      <td>
        `reviewURL`
      </td>

      <td>
        The URL of the review once it has been submitted.
      </td>

      <td>
        [www.ometria.com/review](http://www.ometria.com/review)\
        /12345
      </td>
    </tr>
  </tbody>
</Table>

## Password

### Array - password

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Value
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `token`
      </td>

      <td>
        The password reset token for the contact.
      </td>

      <td>
        [www.ometria.com/reset/1](http://www.ometria.com/reset/1)\
        2345
      </td>
    </tr>
  </tbody>
</Table>

## Attachments

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Value
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `name`
      </td>

      <td>
        The file name of your PDF attachment.
      </td>

      <td>
        order\_confirmation.pdf
      </td>
    </tr>

    <tr>
      <td>
        `type`
      </td>

      <td>
        The type of file you're sending.
      </td>

      <td>
        application/pdf
      </td>
    </tr>

    <tr>
      <td>
        `data`
      </td>

      <td>
        The import base 64 string.
      </td>

      <td>
        Q29uZ3JhdHVsYXRpb25zLCB5b3UgY2FuIGJhc2U2NCBkZWNvZGUh
      </td>
    </tr>
  </tbody>
</Table>

## Misc

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Value
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `message`
      </td>

      <td>
        A string message to be included in an email
      </td>

      <td>
        Great to hear from you, we’ll look into your comments.
      </td>
    </tr>

    <tr>
      <td>
        `website`
      </td>

      <td>
        A URL to your website (if different to your base URL in Ometria).
      </td>

      <td>
        [www.ometria.com](http://www.ometria.com)
      </td>
    </tr>
  </tbody>
</Table>