Package com.commercetools.api.models.order

Interface ShipmentState

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
ShipmentState.ShipmentStateEnum
public interface ShipmentState extends JsonEnum

Indicates the shipment status of the Order.

  • Field Details

    • SHIPPED

      static final ShipmentState SHIPPED

      Indicates that the Order is shipped.

    • DELIVERED

      static final ShipmentState DELIVERED

      Indicates that the Order is delivered.

    • READY

      static final ShipmentState READY

      Indicates that the Order is ready to be shipped.

    • PENDING

      static final ShipmentState PENDING

      Indicates that the shipment of the Order is pending.

    • DELAYED

      static final ShipmentState DELAYED

      Indicates that the shipment of the Order is delayed.

    • PARTIAL

      static final ShipmentState PARTIAL

      Indicates that items in the Order are shipped in more than one shipment.

    • BACKORDER

      static final ShipmentState BACKORDER

      Indicates that items in the Order are not in stock and will be delivered once the items are restocked.

    • CANCELED

      static final ShipmentState CANCELED

      Indicates that the shipment of the Order is canceled.

  • Method Details

    • getJsonName

      String getJsonName()
      the JSON value
      Specified by:
      getJsonName in interface JsonEnum
      Returns:
      json value

    • name

      String name()
      the enum value
      Specified by:
      name in interface JsonEnum
      Returns:
      name

    • toString

      String toString()
      convert value to string
      Specified by:
      toString in interface JsonEnum
      Overrides:
      toString in class Object
      Returns:
      string representation

    • findEnum

      static ShipmentState findEnum(String value)
      factory method for a enum value of ShipmentState if no enum has been found an anonymous instance will be created
      Parameters:
      value - the enum value to be wrapped
      Returns:
      enum instance

    • findEnumViaJsonName

      static Optional<ShipmentState> findEnumViaJsonName(String jsonName)
      method to find enum using the JSON value
      Parameters:
      jsonName - the json value to be wrapped
      Returns:
      optional of enum instance

    • values

      static ShipmentState[] values()
      possible enum values
      Returns:
      array of possible enum values