Transactional API data sets

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

Contact

Array - contact

ValueDescriptionExample
emailThe contact's email address.[email protected]
phoneThe contact's phone number.07712312334
titleThe contact's title.Ms
nameThe contact's first and last name.Jane Smith
firstnameThe contact's first name.Jane
surnameThe contact's last name.Smith
contactIDThe contact's ID.1234
accountURLThe URL to access the contact's account settings.www.fashionshop.com/myacc
ount/12345

Order

Array - details

ValueDescriptionExample
orderIDThe ID of the order placed.00002501
creationDateThe date and time the order was placed.01/16/2019 9:50 am
statusThe status of the order.New
orderDetailsURLA link direct to the order details.www.fashionshop.com/brand/orders
couponsAny coupon code(s) used in the order.Welcome10

Array - payment

ValueDescriptionExample
paymentMethodThe method of payment used in the order.Credit Card
lastFourThe last four digits on the credit card used in the order.1234
amountThe monetary amount paid.£1530

Array - totals

ValueDescriptionExample
subTotalThe subtotal for the order excluding shipping and tax.£1530
'totalShippingCost'The shipping cost for the order.£5
totalTaxThe tax cost for the order.£5
grandTotalThe total for the order including
shipping and tax.
£1535

Array - shipping

ValueDescriptionExample
address1 The first line of the shipping address.1 Example Road
address2The second line of the shipping address.West Quarter
address3The third line of the shipping address.Townsville
cityThe city of the shipping address.London
countyThe state or county of the shipping address.Greater London
postcodeThe shipping address postcode or zip code.EC1 1HY
countrycodeThe shipping address country code.GB
trackingIDThe ID of the tracking service.1223
trackingURLThe URL of the tracking service.www.ometria.com/trackin
g/1223

Array - billing

ValueDescriptionExample
address1The first line of the billing address.1 Example Road
address2The second line of the billing address.West Quarter
address3The third line of the billing address.Townsville
cityThe city of the billing address.London
countyThe state or county of the billing address.Greater London
postcodeThe billing address postcode or zip code.EC1 1HY
countrycodeThe shipping address country code.GB

Array - items

ValueDescriptionExample
imgUrlThe product image URL.https://www.ometria.com/
img/12243563.jpg
productIDThe product's ID.12243563
colourThe product's colour.Green
urlThe URL of the product on your website.https://www.ometria.com/
product/12243563.html
quantityThe quantity of the products purchased, refunded or added to wishlist.1
sizeNameThe product size.12
sizeDescriptionA description of the product size.UK size 12 Trousers.
priceThe product price.£25.00
discountAny discount applied to the order.£10
subTotalThe price of the product multiplied by the quantity.£25.00
lengthThe product length.Short.
productNameThe product name.Green trousers.
skuThe product SKU.green_trousers

Review

Array - review

ValueDescriptionExample
tokenThe URL for submitting the review.www.ometria.com/review
/12345
reviewURLThe URL of the review once it has been submitted.www.ometria.com/review
/12345

Password

Array - password

ValueDescriptionExample
tokenThe password reset token for the contact.www.ometria.com/reset/1
2345

Misc

ValueDescriptionExample
messageA string message to be included in an emailGreat to hear from you, we’ll look into your comments.
websiteA URL to your website (if different to your base URL in Ometria).www.ometria.com