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

Class OrdersClient

java.lang.Object

com.chrt.api.resources.shipping.orders.OrdersClient

public class OrdersClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions
protected java.util.function.Supplier<ExpandedClient>	expandedClient

Constructor Summary

Constructors

Constructor	Description
OrdersClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
boolean	cancelManyV1(OrdersCancelManyReq request)	Cancels multiple orders and their non-terminal child entities in a transaction.
boolean	cancelManyV1(OrdersCancelManyReq request, RequestOptions requestOptions)	Cancels multiple orders and their non-terminal child entities in a transaction.
boolean	cancelV1(java.lang.String orderId)	Cancels an order and non-terminal child entities in a transaction.
boolean	cancelV1(java.lang.String orderId, RequestOptions requestOptions)	Cancels an order and non-terminal child entities 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.
java.util.List<OrderTypeaheadResult>	typeaheadV1(OrdersTypeaheadV1Request request)	Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex.
java.util.List<OrderTypeaheadResult>	typeaheadV1(OrdersTypeaheadV1Request request, RequestOptions requestOptions)	Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex.
OrdersUpdateOffChrtReferenceIdRes	updateOffChrtReferenceIdV1(java.lang.String orderId)	Updates off_chrt_reference_id on a non-draft order.
OrdersUpdateOffChrtReferenceIdRes	updateOffChrtReferenceIdV1(java.lang.String orderId, OrdersUpdateOffChrtReferenceIdReq request)	Updates off_chrt_reference_id on a non-draft order.
OrdersUpdateOffChrtReferenceIdRes	updateOffChrtReferenceIdV1(java.lang.String orderId, OrdersUpdateOffChrtReferenceIdReq request, RequestOptions requestOptions)	Updates off_chrt_reference_id on a non-draft order.
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

clientOptions

protected final ClientOptions clientOptions

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

typeaheadV1

public java.util.List<OrderTypeaheadResult> typeaheadV1(OrdersTypeaheadV1Request request)

Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft orders visible to the caller's org. | authz: allowed_org_types=[provider, shipper], min_org_role=operator | () -> (list[OrderTypeaheadResult])

typeaheadV1

public java.util.List<OrderTypeaheadResult> typeaheadV1(OrdersTypeaheadV1Request request,
                                                        RequestOptions requestOptions)

Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft orders visible to the caller's org. | authz: allowed_org_types=[provider, shipper], min_org_role=operator | () -> (list[OrderTypeaheadResult])

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)

updateOffChrtReferenceIdV1

public OrdersUpdateOffChrtReferenceIdRes updateOffChrtReferenceIdV1(java.lang.String orderId)

Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)

updateOffChrtReferenceIdV1

public OrdersUpdateOffChrtReferenceIdRes updateOffChrtReferenceIdV1(java.lang.String orderId,
                                                                    OrdersUpdateOffChrtReferenceIdReq request)

Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)

updateOffChrtReferenceIdV1

public OrdersUpdateOffChrtReferenceIdRes updateOffChrtReferenceIdV1(java.lang.String orderId,
                                                                    OrdersUpdateOffChrtReferenceIdReq request,
                                                                    RequestOptions requestOptions)

Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)

cancelV1

public boolean cancelV1(java.lang.String orderId)

Cancels an order and non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)

cancelV1

public boolean cancelV1(java.lang.String orderId,
                        RequestOptions requestOptions)

Cancels an order and non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)

cancelManyV1

public boolean cancelManyV1(OrdersCancelManyReq request)

Cancels multiple orders and their non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | (OrdersCancelManyReq) -> (bool)

cancelManyV1

public boolean cancelManyV1(OrdersCancelManyReq request,
                            RequestOptions requestOptions)

Cancels multiple orders and their non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | (OrdersCancelManyReq) -> (bool)

expanded

public ExpandedClient expanded()