Skip to main content

ShipmentSortField

Available fields for sorting shipment results in search operations

enum ShipmentSortField {
  ID
  LAST_MODIFIED_AT
  CREATED_AT
  EXPECTED_DELIVERY_AT
  STATUS
  ORDER_ID
}

Values​

ShipmentSortField.ID​

Sort by shipment unique identifier (UUID)

ShipmentSortField.LAST_MODIFIED_AT​

Sort by the date when shipment information was last updated

ShipmentSortField.CREATED_AT​

Sort by the date when shipment was initially created

ShipmentSortField.EXPECTED_DELIVERY_AT​

Sort by the expected delivery date for customer communication

ShipmentSortField.STATUS​

Sort by shipment processing status alphabetically

ShipmentSortField.ORDER_ID​

Sort by the associated order identifier numerically

Member Of​

ShipmentSortInput input