Transactional API data sets
We recommend using the following schema to name your data parameters.
Contact
Array - contact
Value | Description | Example |
---|---|---|
| The contact's email address. | |
| The contact's phone number. | 07712312334 |
| The contact's title. | Ms |
| The contact's first and last name. | Jane Smith |
| The contact's first name. | Jane |
| The contact's last name. | Smith |
| The contact's ID. | 1234 |
| The URL to access the contact's account settings. | www.fashionshop.com/myacc |
Order
Array - details
Value | Description | Example |
---|---|---|
| The ID of the order placed. | 00002501 |
| The date and time the order was placed. | 01/16/2019 9:50 am |
| The status of the order. | New |
| A link direct to the order details. | |
| Any coupon code(s) used in the order. | Welcome10 |
Array - payment
Value | Description | Example |
---|---|---|
| The method of payment used in the order. | Credit Card |
| The last four digits on the credit card used in the order. | 1234 |
| The monetary amount paid. | £1530 |
Array - totals
Value | Description | Example |
---|---|---|
| The subtotal for the order excluding shipping and tax. | £1530 |
'totalShippingCost' | The shipping cost for the order. | £5 |
| The tax cost for the order. | £5 |
| The total for the order including | £1535 |
Array - shipping
Value | Description | Example |
---|---|---|
| The first line of the shipping address. | 1 Example Road |
| The second line of the shipping address. | West Quarter |
| The third line of the shipping address. | Townsville |
| The city of the shipping address. | London |
| The state or county of the shipping address. | Greater London |
| The shipping address postcode or zip code. | EC1 1HY |
| The shipping address country code. | GB |
| The ID of the tracking service. | 1223 |
| The URL of the tracking service. | www.ometria.com/trackin |
Array - billing
Value | Description | Example |
---|---|---|
| The first line of the billing address. | 1 Example Road |
| The second line of the billing address. | West Quarter |
| The third line of the billing address. | Townsville |
| The city of the billing address. | London |
| The state or county of the billing address. | Greater London |
| The billing address postcode or zip code. | EC1 1HY |
| The shipping address country code. | GB |
Array - items
Value | Description | Example |
---|---|---|
| The product image URL. | https://www.ometria.com/ |
| The product's ID. | 12243563 |
| The product's colour. | Green |
| The URL of the product on your website. | https://www.ometria.com/ |
| The quantity of the products purchased, refunded or added to wishlist. | 1 |
| The product size. | 12 |
| A description of the product size. | UK size 12 Trousers. |
| The product price. | £25.00 |
| Any discount applied to the order. | £10 |
| The price of the product multiplied by the quantity. | £25.00 |
| The product length. | Short. |
| The product name. | Green trousers. |
| The product SKU. | green_trousers |
Review
Array - review
Value | Description | Example |
---|---|---|
| The URL for submitting the review. | www.ometria.com/review |
| The URL of the review once it has been submitted. | www.ometria.com/review |
Password
Array - password
Value | Description | Example |
---|---|---|
| The password reset token for the contact. |
Attachments
Value | Description | Example |
---|---|---|
| The file name of your PDF attachment. | order_confirmation.pdf |
| The type of file you're sending. | application/pdf |
| The import base 64 string. | Q29uZ3JhdHVsYXRpb25zLCB5b3UgY2FuIGJhc2U2NCBkZWNvZGUh |
Misc
Value | Description | Example |
---|---|---|
| A string message to be included in an email | Great to hear from you, we’ll look into your comments. |
| A URL to your website (if different to your base URL in Ometria). |
Updated about 14 hours ago