What is a Meta Field?
A Meta Field consists of a Meta Key, which defines the property you are defining, and a Meta Value, which is the value of the property.
For example, the Meta Key "gs1_template" may have a Meta Value of "Default".
Why we use Meta Values
You could use Meta Values to store arbitrary data RyderShip doesn't need to ship Orders, but you need on the Packing Slip or some other resource. They can also be used in Search Filters, which can be applied to Rules, Bulk Actions, or Reporting.
Access
We now allow arbitrary Meta Keys, eliminating the need for prior validation and creation before their usage.
Note: You must use the Line per SKU importer to upload an order.
Meta Field Value Types
When setting meta field values, ensure that the format matches the expected type. Incorrect formats may result in errors, data misinterpretation, or failed validations.
| Type | Expected format | Acceptable values | Additional info |
| DateTime |
Date: Time:
|
|
| Date |
Example: 2025/08/25 will be interpreted as |
No time component is allowed |
| Boolean |
Accepts:
Values are case-insensitive |
|
| String |
|
Cast to a Ruby String object |
| Integer |
|
Non-numeric strings will result in errors |
| Float |
|
Parsed using Ruby’s Float method |
If a value fails to match its expected type, the request may be rejected, or the field may be ignored depending on how your integration is implemented.
Using Meta Values
In Searches
Search Filters are powerful. You can find orders containing Meta Fields (i.e. "Batch all the order-type: VIP orders") or use them for Rules (i.e. "if packaging-type: eco, use paper mailers").
When using a boolean (True/False) in meta field search filters, use the value 1 for true and 0 for false. For best results, combine the Meta Fields with another search filter. An example would be to include a filter like Status or a date range.
The following equates to "is_gift: true":
During Receiving
Shipnotice.item and Shipnotice Meta Fields are searchable on the Ship Notice Details page. These are most frequently used when locating an inbound item by a Meta Key, such as "vendor_sku" or "color_code". In this way, Meta Keys are a tool for Receiving Teams to identify items.
In Templates
Check out our documentation regarding templates here.
Adding Meta Values via CSV upload
Meta Values can be added via CSV Order upload or the API.
Note: You must use the Line per SKU importer to upload an order.
CSV header format:
object_meta_{yourmetakeyhere)
Orders
order_meta
orderitem_meta
Ship Notices
shipnotice_meta
shipnoticeitem_meta
Returns
consumerreturn_meta
shipnoticeitem_meta
Items
item_meta
Note: Attached to this article is an example of the standard Ship Notice import format being used to include meta keys.
Meta Fields are surfaced in the UI, right?
No! But this is intentional. Mistakes happen when we’re relying on humans making right decision based on written instruction for thousands of packages a day. We’re all about automation.
For example, we might use the filter Meta Field packaging_type: eco-friendly to apply a Rule.
Or, we might use user_status: VIP to create Batches.
This means that warehouse staff are getting instructions in the way they’re used to—contextually, via the packing and batching workflows—and don’t need to change their process at all to ship orders in the way you intend.
One exception: Item level Meta Fields are visible on the Item Details page, under the "More" menu. This is to give receiving teams as much information as possible about the items and give them the best possible chance of identifying the right thing during receiving.
Example of the standard Ship Notice import format
- ship notice meta key example.csv191 Bytes