Transaction Attributes Overview
- Viktor Balog (Unlicensed)
By default all Maileon transactions follow the the structure outlined by https://dev.maileon.com/api/implementation-guideline/implementation-guidelines-transactions/implementation-guidelines-order-confirmation
Property | Description | Example |
|---|---|---|
order.id | The WooCommerce order id | “1234” |
order.date | The time the transaction was sent at | “2020-06-26 15:43:00” |
order.status | The order status | “completed” |
order.fees | A JSON array of order fees | See below |
order.total_fees | The sum of the fees | 12.5 |
order.total_no_shipping | The order total without shipping | 22.5 |
order.total_tax | The tax total for the order | 0.5 |
order.refunds | An array of refunds associated with the order | See below |
order.total | The order total | 23.0 |
order.product_ids | A comma separated list of product ids | “15,14,32” |
order.currency | The currency of the order | “EUR” |
order.categories | A comma separated list of product category IDs | “12,3” |
order.items | An array of products | See below |
discount.total | The total discounted sum | 0.0 |
discount.rules | A JSON array of applied discount rules | See below |
customer.firstname | The billing first name for the order | “Max” |
customer.lastname | The billing last name for the order | “Mustermann” |
customer.id | The customer id | “1” |
customer.fullname | The full name of the customer | “Max Mustermann” |
billing.address.zip | The ZIP code for the billing address | “1234” |
billing.address.country | The country code for the billing address | “HU” |
billing.address.firstname | The billing first name for the order | “Max” |
billing.address.lastname | The billing last name for the order | “Mustermann” |
billing.address.fullname | The full name of the customer | “Max Mustermann” |
billing.address.city | The billing address city | “Budapest” |
billing.address.region | The billing address region | “BU” |
billing.address.street | The billing address street | “Test street 12” |
shipping.service.id | The shipping method id | “flat_rate” |
shipping.service.name | The shipping method name | “Flat Rate Shipping” |
Order fees
Property | Description | Example |
|---|---|---|
id | The fee id | “flat_rate” |
name | The display name of the fee | “Flat Rate Shipping” |
total | The total value of the fee | 0.5 |
Order Items
Property | Description | Example |
|---|---|---|
sku | The SKU of the product | “woo-example-item” |
product_id | The ID of the product | 12 |
title | The name of the product | “An Example Product” |
description | The full description of the product | “This is a much longer description.” |
short_description | The short description of the product | “Short description” |
url | The public url of the product | “http://example.com/shop/example-product” |
image_url | The public image url of the product | “http://example.com/shop/example-product.jpg” |
status | The stock status of the product | “instock” |
single_price | The single price of the product | 10.5 |
categories | The comma separated category ids of the product | “12,3” |
width | The width of the product | 123 |
height | The height of the product | 123 |
weight | The weight of the product | 1000 |
attributes | The attributes of the product as a JSON object | {“pa_color”: [“red”]} |
quantity | The quantity of the product | 2 |
total | The line total of the product | 21.0 |
Order refunds
Property | Description | Example |
|---|---|---|
total | The line total of the refund | 0.5 |
description | The refund reason | “Shipping cost” |
Discount rules
Property | Description | Example |
|---|---|---|
id | The coupon code | “15OFF” |
name | The coupon name | “15% OFF” |
total | The line total of the coupon | 2.5 |
type | Always ‘absolute’ for coupons |
|