com.squareup.square.api

Class DefaultOrdersApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultOrdersApi

All Implemented Interfaces:

OrdersApi

public final class DefaultOrdersApi
extends BaseApi
implements OrdersApi

This class lists all the endpoints of the groups.

Nested Class Summary

Nested classes/interfaces inherited from class com.squareup.square.api.BaseApi

BaseApi.RequestExecutor, BaseApi.RequestSupplier, BaseApi.ResponseHandler<T>

Field Summary

Fields inherited from class com.squareup.square.api.BaseApi

authManagers, config, httpCallback, internalUserAgent

Constructor Summary

Constructors

Constructor and Description
DefaultOrdersApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultOrdersApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

Method Summary

Modifier and Type	Method and Description
BatchRetrieveOrdersResponse	batchRetrieveOrders(BatchRetrieveOrdersRequest body) Retrieves a set of [orders]($m/Order) by their IDs.
CompletableFuture<BatchRetrieveOrdersResponse>	batchRetrieveOrdersAsync(BatchRetrieveOrdersRequest body) Retrieves a set of [orders]($m/Order) by their IDs.
CalculateOrderResponse	calculateOrder(CalculateOrderRequest body) Enables applications to preview order pricing without creating an order.
CompletableFuture<CalculateOrderResponse>	calculateOrderAsync(CalculateOrderRequest body) Enables applications to preview order pricing without creating an order.
CloneOrderResponse	cloneOrder(CloneOrderRequest body) Creates a new order, in the `DRAFT` state, by duplicating an existing order.
CompletableFuture<CloneOrderResponse>	cloneOrderAsync(CloneOrderRequest body) Creates a new order, in the `DRAFT` state, by duplicating an existing order.
CreateOrderResponse	createOrder(CreateOrderRequest body) Creates a new [order]($m/Order) that can include information about products for purchase and settings to apply to the purchase.
CompletableFuture<CreateOrderResponse>	createOrderAsync(CreateOrderRequest body) Creates a new [order]($m/Order) that can include information about products for purchase and settings to apply to the purchase.
PayOrderResponse	payOrder(String orderId, PayOrderRequest body) Pay for an [order]($m/Order) using one or more approved [payments]($m/Payment) or settle an order with a total of `0`.
CompletableFuture<PayOrderResponse>	payOrderAsync(String orderId, PayOrderRequest body) Pay for an [order]($m/Order) using one or more approved [payments]($m/Payment) or settle an order with a total of `0`.
RetrieveOrderResponse	retrieveOrder(String orderId) Retrieves an [Order]($m/Order) by ID.
CompletableFuture<RetrieveOrderResponse>	retrieveOrderAsync(String orderId) Retrieves an [Order]($m/Order) by ID.
SearchOrdersResponse	searchOrders(SearchOrdersRequest body) Search all orders for one or more locations.
CompletableFuture<SearchOrdersResponse>	searchOrdersAsync(SearchOrdersRequest body) Search all orders for one or more locations.
UpdateOrderResponse	updateOrder(String orderId, UpdateOrderRequest body) Updates an open [order]($m/Order) by adding, replacing, or deleting fields.
CompletableFuture<UpdateOrderResponse>	updateOrderAsync(String orderId, UpdateOrderRequest body) Updates an open [order]($m/Order) by adding, replacing, or deleting fields.

Methods inherited from class com.squareup.square.api.BaseApi

getClientInstance, getHttpCallback, makeHttpCallAsync, validateResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOrdersApi

public DefaultOrdersApi(Configuration config,
                        HttpClient httpClient,
                        Map<String,AuthManager> authManagers)

Initializes the controller.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

DefaultOrdersApi

public DefaultOrdersApi(Configuration config,
                        HttpClient httpClient,
                        Map<String,AuthManager> authManagers,
                        HttpCallback httpCallback)

Initializes the controller with HTTPCallback.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

httpCallback - Callback to be called before and after the HTTP call.

Method Detail

createOrder

public CreateOrderResponse createOrder(CreateOrderRequest body)
                                throws ApiException,
                                       IOException

Creates a new [order]($m/Order) that can include information about products for purchase and settings to apply to the purchase. To pay for a created order, see [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). You can modify open orders using the [UpdateOrder]($e/Orders/UpdateOrder) endpoint.

Specified by:

createOrder in interface OrdersApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateOrderResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createOrderAsync

public CompletableFuture<CreateOrderResponse> createOrderAsync(CreateOrderRequest body)

Creates a new [order]($m/Order) that can include information about products for purchase and settings to apply to the purchase. To pay for a created order, see [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). You can modify open orders using the [UpdateOrder]($e/Orders/UpdateOrder) endpoint.

Specified by:

createOrderAsync in interface OrdersApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateOrderResponse response from the API call

batchRetrieveOrders

public BatchRetrieveOrdersResponse batchRetrieveOrders(BatchRetrieveOrdersRequest body)
                                                throws ApiException,
                                                       IOException

Retrieves a set of [orders]($m/Order) by their IDs. If a given order ID does not exist, the ID is ignored instead of generating an error.

Specified by:

batchRetrieveOrders in interface OrdersApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchRetrieveOrdersResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

batchRetrieveOrdersAsync

public CompletableFuture<BatchRetrieveOrdersResponse> batchRetrieveOrdersAsync(BatchRetrieveOrdersRequest body)

Retrieves a set of [orders]($m/Order) by their IDs. If a given order ID does not exist, the ID is ignored instead of generating an error.

Specified by:

batchRetrieveOrdersAsync in interface OrdersApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BatchRetrieveOrdersResponse response from the API call

calculateOrder

public CalculateOrderResponse calculateOrder(CalculateOrderRequest body)
                                      throws ApiException,
                                             IOException

Enables applications to preview order pricing without creating an order.

Specified by:

calculateOrder in interface OrdersApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CalculateOrderResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

calculateOrderAsync

public CompletableFuture<CalculateOrderResponse> calculateOrderAsync(CalculateOrderRequest body)

Enables applications to preview order pricing without creating an order.

Specified by:

calculateOrderAsync in interface OrdersApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CalculateOrderResponse response from the API call

cloneOrder

public CloneOrderResponse cloneOrder(CloneOrderRequest body)
                              throws ApiException,
                                     IOException

Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has only the core fields (such as line items, taxes, and discounts) copied from the original order.

Specified by:

cloneOrder in interface OrdersApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CloneOrderResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

cloneOrderAsync

public CompletableFuture<CloneOrderResponse> cloneOrderAsync(CloneOrderRequest body)

Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has only the core fields (such as line items, taxes, and discounts) copied from the original order.

Specified by:

cloneOrderAsync in interface OrdersApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CloneOrderResponse response from the API call

searchOrders

public SearchOrdersResponse searchOrders(SearchOrdersRequest body)
                                  throws ApiException,
                                         IOException

Search all orders for one or more locations. Orders include all sales, returns, and exchanges regardless of how or when they entered the Square ecosystem (such as Point of Sale, Invoices, and Connect APIs). `SearchOrders` requests need to specify which locations to search and define a [SearchOrdersQuery]($m/SearchOrdersQuery) object that controls how to sort or filter the results. Your `SearchOrdersQuery` can: Set filter criteria. Set the sort order. Determine whether to return results as complete `Order` objects or as [OrderEntry]($m/OrderEntry) objects. Note that details for orders processed with Square Point of Sale while in offline mode might not be transmitted to Square for up to 72 hours. Offline orders have a `created_at` value that reflects the time the order was created, not the time it was subsequently transmitted to Square.

Specified by:

searchOrders in interface OrdersApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchOrdersResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

searchOrdersAsync

public CompletableFuture<SearchOrdersResponse> searchOrdersAsync(SearchOrdersRequest body)

Search all orders for one or more locations. Orders include all sales, returns, and exchanges regardless of how or when they entered the Square ecosystem (such as Point of Sale, Invoices, and Connect APIs). `SearchOrders` requests need to specify which locations to search and define a [SearchOrdersQuery]($m/SearchOrdersQuery) object that controls how to sort or filter the results. Your `SearchOrdersQuery` can: Set filter criteria. Set the sort order. Determine whether to return results as complete `Order` objects or as [OrderEntry]($m/OrderEntry) objects. Note that details for orders processed with Square Point of Sale while in offline mode might not be transmitted to Square for up to 72 hours. Offline orders have a `created_at` value that reflects the time the order was created, not the time it was subsequently transmitted to Square.

Specified by:

searchOrdersAsync in interface OrdersApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchOrdersResponse response from the API call

retrieveOrder

public RetrieveOrderResponse retrieveOrder(String orderId)
                                    throws ApiException,
                                           IOException

Retrieves an [Order]($m/Order) by ID.

Specified by:

retrieveOrder in interface OrdersApi

Parameters:

orderId - Required parameter: The ID of the order to retrieve.

Returns:

Returns the RetrieveOrderResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveOrderAsync

public CompletableFuture<RetrieveOrderResponse> retrieveOrderAsync(String orderId)

Retrieves an [Order]($m/Order) by ID.

Specified by:

retrieveOrderAsync in interface OrdersApi

Parameters:

orderId - Required parameter: The ID of the order to retrieve.

Returns:

Returns the RetrieveOrderResponse response from the API call

updateOrder

public UpdateOrderResponse updateOrder(String orderId,
                                       UpdateOrderRequest body)
                                throws ApiException,
                                       IOException

Updates an open [order]($m/Order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An `UpdateOrder` request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version to which the update is being applied. - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation) identifying the fields to clear. To pay for an order, see [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).

Specified by:

updateOrder in interface OrdersApi

Parameters:

orderId - Required parameter: The ID of the order to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateOrderResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateOrderAsync

public CompletableFuture<UpdateOrderResponse> updateOrderAsync(String orderId,
                                                               UpdateOrderRequest body)

Updates an open [order]($m/Order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An `UpdateOrder` request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version to which the update is being applied. - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation) identifying the fields to clear. To pay for an order, see [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).

Specified by:

updateOrderAsync in interface OrdersApi

Parameters:

orderId - Required parameter: The ID of the order to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateOrderResponse response from the API call

payOrder

public PayOrderResponse payOrder(String orderId,
                                 PayOrderRequest body)
                          throws ApiException,
                                 IOException

Pay for an [order]($m/Order) using one or more approved [payments]($m/Payment) or settle an order with a total of `0`. The total of the `payment_ids` listed in the request must be equal to the order total. Orders with a total amount of `0` can be marked as paid by specifying an empty array of `payment_ids` in the request. To be used with `PayOrder`, a payment must: - Reference the order by specifying the `order_id` when [creating the payment]($e/Payments/CreatePayment). Any approved payments that reference the same `order_id` not specified in the `payment_ids` is canceled. - Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture). Using a delayed capture payment with `PayOrder` completes the approved payment.

Specified by:

payOrder in interface OrdersApi

Parameters:

orderId - Required parameter: The ID of the order being paid.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the PayOrderResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

payOrderAsync

public CompletableFuture<PayOrderResponse> payOrderAsync(String orderId,
                                                         PayOrderRequest body)

Pay for an [order]($m/Order) using one or more approved [payments]($m/Payment) or settle an order with a total of `0`. The total of the `payment_ids` listed in the request must be equal to the order total. Orders with a total amount of `0` can be marked as paid by specifying an empty array of `payment_ids` in the request. To be used with `PayOrder`, a payment must: - Reference the order by specifying the `order_id` when [creating the payment]($e/Payments/CreatePayment). Any approved payments that reference the same `order_id` not specified in the `payment_ids` is canceled. - Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture). Using a delayed capture payment with `PayOrder` completes the approved payment.

Specified by:

payOrderAsync in interface OrdersApi

Parameters:

orderId - Required parameter: The ID of the order being paid.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the PayOrderResponse response from the API call