Manage shipment attributes
Use shipment attributes to extend the shipment data model with custom fields. You can attach additional information to individual shipments that Carriyo does not capture by default.
Carriyo has two types of shipment attributes:
- Native attributes, built into Carriyo. You cannot add or delete them, but you can configure their allowed values.
- Custom attributes. You create, edit, and delete these. They let you record extra information on each shipment.
Shipment attributes are available in both the Dashboard and the Shipment API.
Creating a custom attribute
1. Navigate to Settings > Administration > Shipment Attributes on the Carriyo Dashboard.
2. Click the + add record button to add a new custom attribute.
3. Enter a concise, readable name for the attribute. Carriyo derives the code from the name (lowercase, underscores). The code is used as the field name in the Shipment API and as the attribute reference in shipping rules, service-level rules, and webhook conditions. Choose one of two value types: enumeration restricts input to a predefined list of allowed values, or free text accepts any value.
4. Click Save. The attribute appears on the create shipment page and is available via the API. If you created the attribute by mistake, the Delete option is available immediately after saving.
5. Both custom attributes and native attributes are editable. Custom attributes can also be deleted.
When a custom attribute is used on a shipment, it appears in the custom attributes section of the Summary tab on the shipment detail page.
Enumeration-type attributes are available as filters on the shipments listing page. The attribute must be used on at least one shipment before it appears as a filter.
Both free text and enumeration attributes can be used as Conditions in Shipping rules and Service level rules.
In the Branded Tracking App, you can configure these attributes to give customers additional visibility into their shipment details.