Skip to main content

Order custom field reference

This lists every detail Trove can add to your WooCommerce orders as a custom field, its default name, and what it contains. You can rename or leave out any of these. See How to send the gift message and order details to your WooCommerce orders.

A custom field is only added when it has a value. If a detail is empty for an order, nothing is sent for it.

The fields​

Label in TroveDefault nameWhat it contains
Trove order numbertrove_orderThe Trove order number.
ChannelchannelAlways the word "Trove".
Buyer namebuyer_nameThe name of the person who placed the order.
Buyer emailbuyer_emailThe buyer's email address.
Delivery informationdelivery_informationThe delivery instructions for the recipient. If there aren't any, it says "No instructions provided".
Package namespackage_namesFor Send to one location orders only. A list of recipient names, separated by commas. If a recipient has a message, it follows their name, like "Sam Lee: Happy birthday!".
Gift messagegift_messageThe gift message. Left out if the order has no gift message.
Scheduled send datescheduled_send_dateThe date the order is scheduled to be sent, as YYYY-MM-DD.
Send date format and timezonesend_date_formatThe text "YYYY-MM-DD". Only present when the scheduled send date is.
Expected delivery dateexpected_delivery_dateThe date the order is expected to be delivered, as YYYY-MM-DD.
Delivery date format and timezonedelivery_date_formatThe text "YYYY-MM-DD". Only present when the expected delivery date is.

More about specific fields​

Gift message​

The gift message has its merge fields filled in for each recipient, so a message with the recipient's first name, last name or full name in it shows their actual name on the WooCommerce order.

Scheduled send date or expected delivery date​

These are only added when the order has a schedule date, and only for Multiple Addresses and Send to one location orders.

An order has one or the other, never both:

  • If your storefront has an active delivery schedule for that delivery method, the date is the date the buyer chose for delivery. It's sent as Expected delivery date.
  • Otherwise the date is the date the order is sent. It's sent as Scheduled send date.

Dates are in the format YYYY-MM-DD. The format fields don't include a time zone, even though their labels mention one.

How many WooCommerce orders are created​

Trove sends a separate order to WooCommerce for each recipient. The exception is Send to one location, which sends a single combined order for the whole delivery. Email and link orders are sent once a recipient has redeemed their gift.

Each of those orders carries the custom fields above.