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

Class ExpandedClient

java.lang.Object

com.chrt.api.resources.shipping.orderdrafts.expanded.ExpandedClient

public class ExpandedClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ExpandedClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
OrderDraftExpandedListRes	listV1(ExpandedListV1Request request)	Lists expanded draft orders for the organization with filtering, sorting, pagination, and optional search.
OrderDraftExpandedListRes	listV1(ExpandedListV1Request request, RequestOptions requestOptions)	Lists expanded draft orders for the organization with filtering, sorting, pagination, and optional search.
OrderDraftExpanded	retrieveV1(java.lang.String orderRef)	Fetches a single draft order with optional expanded related data.
OrderDraftExpanded	retrieveV1(java.lang.String orderRef, OrderAndTaskGroupExpandedReq request)	Fetches a single draft order with optional expanded related data.
OrderDraftExpanded	retrieveV1(java.lang.String orderRef, OrderAndTaskGroupExpandedReq request, RequestOptions requestOptions)	Fetches a single draft order with optional expanded related data.
java.util.List<OrderTypeaheadResult>	typeaheadV1(ExpandedTypeaheadV1Request request)	Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex.
java.util.List<OrderTypeaheadResult>	typeaheadV1(ExpandedTypeaheadV1Request request, RequestOptions requestOptions)	Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex.
RawExpandedClient	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

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

ExpandedClient

public ExpandedClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawExpandedClient withRawResponse()

Get responses with HTTP metadata like headers

retrieveV1

public OrderDraftExpanded retrieveV1(java.lang.String orderRef)

Fetches a single draft order with optional expanded related data. Any user in the org (with operator+ role) can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)

retrieveV1

public OrderDraftExpanded retrieveV1(java.lang.String orderRef,
                                     OrderAndTaskGroupExpandedReq request)

Fetches a single draft order with optional expanded related data. Any user in the org (with operator+ role) can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)

retrieveV1

public OrderDraftExpanded retrieveV1(java.lang.String orderRef,
                                     OrderAndTaskGroupExpandedReq request,
                                     RequestOptions requestOptions)

Fetches a single draft order with optional expanded related data. Any user in the org (with operator+ role) can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)

listV1

public OrderDraftExpandedListRes listV1(ExpandedListV1Request request)

Lists expanded draft orders for the organization with filtering, sorting, pagination, and optional search. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpandedListRes)

listV1

public OrderDraftExpandedListRes listV1(ExpandedListV1Request request,
                                        RequestOptions requestOptions)

Lists expanded draft orders for the organization with filtering, sorting, pagination, and optional search. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpandedListRes)

typeaheadV1

public java.util.List<OrderTypeaheadResult> typeaheadV1(ExpandedTypeaheadV1Request 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.List<OrderTypeaheadResult> typeaheadV1(ExpandedTypeaheadV1Request 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])