This article discusses the creation and management of Shipment Attributes in Carriyo.
Shipment attributes are a powerful feature that allows extending and customizing the shipments data model and add custom information to each individual shipment.
Carriyo makes use of two distinct types of shipment attributes:
- Native Attributes. Native Attributes cannot be added or deleted as they are native to Carriyo. However, their possible values can be configured.
- Custom Attributes, on the other hand, can be added, deleted, and edited. Shipment Attributes facilitate in providing additional information about the shipment.
Note: Custom Attributes are only available in specific Carriyo accounts and plans.
Shipment attributes are accessible through both the Dashboard and the Shipment API.
Permissions: Only users with Admin roles are able to handle creation and management of shipment attributes.
Creating a Custom Attribute
1. Navigate to Settings > Administration > Shipment Attributes on the Carriyo Dashboard.
2. To add a new custom attribute, click on the + add record button.
2. Provide a concise and readable name for the attribute. The code is internal to Carriyo and is used to identify the Custom Attribute. The attribute can have either of two value types: enumeration, which restricts input to the allowed values configured here, or free text, which allows users to input any value.
3. Once the required details are entered, click on Save for the changes to be reflected in the Create Shipment page or via the API. The immediate option provided is delete in case the process was accidental.
4. Both Custom and Native Attributes are editable. Custom Attributes will additionally have the option to be deleted.
If custom attributes are used for a shipment, this information will be displayed under Custom Attributes section in the Summary tab inside the Shipment Detail Page.
All shipment attributes of the enumeration type will be available as filters list on the Shipments listing page.
Note: These attributes must be used in at least one shipment for them to appear here.
Additionally, these attributes, both free text and enumeration can also be used in shipping/automation rules and Service Level rules in the form of Conditions.
In the Branded Tracking App, these attributes can be configured to provide customers with added visibility of shipment details for their orders.
Comments
0 comments
Please sign in to leave a comment.