Package com.chrt.api.resources.shipping.orders

Class OrdersClient

  • public class OrdersClient
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean cancelV1​(java.lang.String orderId)
      Cancels an order and all related task groups and tasks in a transaction.
      boolean cancelV1​(java.lang.String orderId, RequestOptions requestOptions)
      Cancels an order and all related task groups and tasks in a transaction.
      ExpandedClient expanded()  
      boolean stageV1​(java.lang.String orderId)
      Validates a draft order and stages all related entities in a transaction.
      boolean stageV1​(java.lang.String orderId, RequestOptions requestOptions)
      Validates a draft order and stages all related entities in a transaction.
      RawOrdersClient withRawResponse()
      Get responses with HTTP metadata like headers

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • expandedClient

        protected final java.util.function.Supplier<ExpandedClient> expandedClient

    • Constructor Detail

      • OrdersClient

        public OrdersClient​(ClientOptions clientOptions)

    • Method Detail

      • withRawResponse

        public RawOrdersClient withRawResponse()
        Get responses with HTTP metadata like headers

      • stageV1

        public boolean stageV1​(java.lang.String orderId)
        Validates a draft order and stages all related entities in a transaction. | () -> (bool)

      • stageV1

        public boolean stageV1​(java.lang.String orderId,
                       RequestOptions requestOptions)
        Validates a draft order and stages all related entities in a transaction. | () -> (bool)

      • cancelV1

        public boolean cancelV1​(java.lang.String orderId)
        Cancels an order and all related task groups and tasks in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)

      • cancelV1

        public boolean cancelV1​(java.lang.String orderId,
                        RequestOptions requestOptions)
        Cancels an order and all related task groups and tasks in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)