Package com.chrt.api.resources.shipping.orderdrafts

Class AsyncRawOrderDraftsClient

  • public class AsyncRawOrderDraftsClient
extends java.lang.Object

    • Constructor Detail

      • AsyncRawOrderDraftsClient

        public AsyncRawOrderDraftsClient​(ClientOptions clientOptions)

    • Method Detail

      • newV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<OrdersNewDraftRes>> newV1()
        Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)

      • updateV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<OrdersDraftUpdateRes>> updateV1​(java.lang.String orderId)
        Updates coordinator and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)

      • setTaskGroupOrderingV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> setTaskGroupOrderingV1​(java.lang.String orderId,
                                                                                                             SetTaskGroupOrderingDraftReq request)
        Sets the ordering of task groups within a draft order. Must provide all task group IDs with no duplicates. | (SetTaskGroupOrderingDraftReq) -> (bool)

      • setTaskGroupOrderingV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> setTaskGroupOrderingV1​(java.lang.String orderId,
                                                                                                             SetTaskGroupOrderingDraftReq request,
                                                                                                             RequestOptions requestOptions)
        Sets the ordering of task groups within a draft order. Must provide all task group IDs with no duplicates. | (SetTaskGroupOrderingDraftReq) -> (bool)

      • deleteV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> deleteV1​(java.lang.String orderId)
        Deletes a draft order and all associated entities. | () -> (bool)

      • deleteV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> deleteV1​(java.lang.String orderId,
                                                                                               RequestOptions requestOptions)
        Deletes a draft order and all associated entities. | () -> (bool)

      • deleteManyV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> deleteManyV1​(OrdersDraftDeleteManyReq request)
        Deletes multiple draft orders and associated entities. | (OrdersDraftDeleteManyReq) -> (bool)

      • typeaheadV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.util.List<OrderTypeaheadResult>>> typeaheadV1​(OrderDraftsTypeaheadV1Request request)
        Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches draft orders created by the caller's org. | authz: min_org_role=operator | () -> (list[OrderTypeaheadResult])

      • typeaheadV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.util.List<OrderTypeaheadResult>>> typeaheadV1​(OrderDraftsTypeaheadV1Request request,
                                                                                                                     RequestOptions requestOptions)
        Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches draft orders created by the caller's org. | authz: min_org_role=operator | () -> (list[OrderTypeaheadResult])

      • validateV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<OrderDraftValidationResult>> validateV1​(java.lang.String orderId)
        Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)