Package com.adyen.service.management

Class TerminalOrdersMerchantLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.TerminalOrdersMerchantLevelApi

public class TerminalOrdersMerchantLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
TerminalOrdersMerchantLevelApi(Client client)	Terminal orders - merchant level constructor in package.
TerminalOrdersMerchantLevelApi(Client client, String baseURL)	Terminal orders - merchant level constructor in package.

Method Summary

Modifier and Type	Method	Description
TerminalOrder	cancelOrder(String merchantId, String orderId)	Cancel an order
TerminalOrder	cancelOrder(String merchantId, String orderId, RequestOptions requestOptions)	Cancel an order
TerminalOrder	createOrder(String merchantId, TerminalOrderRequest terminalOrderRequest)	Create an order
TerminalOrder	createOrder(String merchantId, TerminalOrderRequest terminalOrderRequest, RequestOptions requestOptions)	Create an order
ShippingLocation	createShippingLocation(String merchantId, ShippingLocation shippingLocation)	Create a shipping location
ShippingLocation	createShippingLocation(String merchantId, ShippingLocation shippingLocation, RequestOptions requestOptions)	Create a shipping location
TerminalOrder	getOrder(String merchantId, String orderId)	Get an order
TerminalOrder	getOrder(String merchantId, String orderId, RequestOptions requestOptions)	Get an order
BillingEntitiesResponse	listBillingEntities(String merchantId)	Get a list of billing entities
BillingEntitiesResponse	listBillingEntities(String merchantId, String name, RequestOptions requestOptions)	Get a list of billing entities
TerminalOrdersResponse	listOrders(String merchantId)	Get a list of orders
TerminalOrdersResponse	listOrders(String merchantId, String customerOrderReference, String status, Integer offset, Integer limit, RequestOptions requestOptions)	Get a list of orders
ShippingLocationsResponse	listShippingLocations(String merchantId)	Get a list of shipping locations
ShippingLocationsResponse	listShippingLocations(String merchantId, String name, Integer offset, Integer limit, RequestOptions requestOptions)	Get a list of shipping locations
TerminalModelsResponse	listTerminalModels(String merchantId)	Get a list of terminal models
TerminalModelsResponse	listTerminalModels(String merchantId, RequestOptions requestOptions)	Get a list of terminal models
TerminalProductsResponse	listTerminalProducts(String merchantId, String country)	Get a list of terminal products
TerminalProductsResponse	listTerminalProducts(String merchantId, String country, String terminalModelId, Integer offset, Integer limit, RequestOptions requestOptions)	Get a list of terminal products
TerminalOrder	updateOrder(String merchantId, String orderId, TerminalOrderRequest terminalOrderRequest)	Update an order
TerminalOrder	updateOrder(String merchantId, String orderId, TerminalOrderRequest terminalOrderRequest, RequestOptions requestOptions)	Update an order

Methods inherited from class com.adyen.Service

createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

baseURL

protected String baseURL

Constructor Detail

TerminalOrdersMerchantLevelApi

public TerminalOrdersMerchantLevelApi(Client client)

Terminal orders - merchant level constructor in package.

Parameters:

client - Client (required)

TerminalOrdersMerchantLevelApi

public TerminalOrdersMerchantLevelApi(Client client,
                                      String baseURL)

Terminal orders - merchant level constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.

Parameters:

client - Client (required)

baseURL - String (required)

Method Detail

cancelOrder

public TerminalOrder cancelOrder(String merchantId,
                                 String orderId)
                          throws ApiException,
                                 IOException

Cancel an order

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

orderId - String The unique identifier of the order. (required)

Returns:

TerminalOrder

Throws:

ApiException - if fails to make API call

IOException

cancelOrder

public TerminalOrder cancelOrder(String merchantId,
                                 String orderId,
                                 RequestOptions requestOptions)
                          throws ApiException,
                                 IOException

Cancel an order

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

orderId - String The unique identifier of the order. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

TerminalOrder

Throws:

ApiException - if fails to make API call

IOException

createOrder

public TerminalOrder createOrder(String merchantId,
                                 TerminalOrderRequest terminalOrderRequest)
                          throws ApiException,
                                 IOException

Create an order

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

terminalOrderRequest - TerminalOrderRequest (required)

Returns:

TerminalOrder

Throws:

ApiException - if fails to make API call

IOException

createOrder

public TerminalOrder createOrder(String merchantId,
                                 TerminalOrderRequest terminalOrderRequest,
                                 RequestOptions requestOptions)
                          throws ApiException,
                                 IOException

Create an order

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

terminalOrderRequest - TerminalOrderRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

TerminalOrder

Throws:

ApiException - if fails to make API call

IOException

createShippingLocation

public ShippingLocation createShippingLocation(String merchantId,
                                               ShippingLocation shippingLocation)
                                        throws ApiException,
                                               IOException

Create a shipping location

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

shippingLocation - ShippingLocation (required)

Returns:

ShippingLocation

Throws:

ApiException - if fails to make API call

IOException

createShippingLocation

public ShippingLocation createShippingLocation(String merchantId,
                                               ShippingLocation shippingLocation,
                                               RequestOptions requestOptions)
                                        throws ApiException,
                                               IOException

Create a shipping location

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

shippingLocation - ShippingLocation (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

ShippingLocation

Throws:

ApiException - if fails to make API call

IOException

getOrder

public TerminalOrder getOrder(String merchantId,
                              String orderId)
                       throws ApiException,
                              IOException

Get an order

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

orderId - String The unique identifier of the order. (required)

Returns:

TerminalOrder

Throws:

ApiException - if fails to make API call

IOException

getOrder

public TerminalOrder getOrder(String merchantId,
                              String orderId,
                              RequestOptions requestOptions)
                       throws ApiException,
                              IOException

Get an order

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

orderId - String The unique identifier of the order. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

TerminalOrder

Throws:

ApiException - if fails to make API call

IOException

listBillingEntities

public BillingEntitiesResponse listBillingEntities(String merchantId)
                                            throws ApiException,
                                                   IOException

Get a list of billing entities

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

Returns:

BillingEntitiesResponse

Throws:

ApiException - if fails to make API call

IOException

listBillingEntities

public BillingEntitiesResponse listBillingEntities(String merchantId,
                                                   String name,
                                                   RequestOptions requestOptions)
                                            throws ApiException,
                                                   IOException

Get a list of billing entities

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

name - String Query: The name of the billing entity. (optional)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

BillingEntitiesResponse

Throws:

ApiException - if fails to make API call

IOException

listOrders

public TerminalOrdersResponse listOrders(String merchantId)
                                  throws ApiException,
                                         IOException

Get a list of orders

Parameters:

merchantId - String (required)

Returns:

TerminalOrdersResponse

Throws:

ApiException - if fails to make API call

IOException

listOrders

public TerminalOrdersResponse listOrders(String merchantId,
                                         String customerOrderReference,
                                         String status,
                                         Integer offset,
                                         Integer limit,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Get a list of orders

Parameters:

merchantId - String (required)

customerOrderReference - String Query: Your purchase order number. (optional)

status - String Query: The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered. (optional)

offset - Integer Query: The number of orders to skip. (optional)

limit - Integer Query: The number of orders to return. (optional)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

TerminalOrdersResponse

Throws:

ApiException - if fails to make API call

IOException

listShippingLocations

public ShippingLocationsResponse listShippingLocations(String merchantId)
                                                throws ApiException,
                                                       IOException

Get a list of shipping locations

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

Returns:

ShippingLocationsResponse

Throws:

ApiException - if fails to make API call

IOException

listShippingLocations

public ShippingLocationsResponse listShippingLocations(String merchantId,
                                                       String name,
                                                       Integer offset,
                                                       Integer limit,
                                                       RequestOptions requestOptions)
                                                throws ApiException,
                                                       IOException

Get a list of shipping locations

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

name - String Query: The name of the shipping location. (optional)

offset - Integer Query: The number of locations to skip. (optional)

limit - Integer Query: The number of locations to return. (optional)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

ShippingLocationsResponse

Throws:

ApiException - if fails to make API call

IOException

listTerminalModels

public TerminalModelsResponse listTerminalModels(String merchantId)
                                          throws ApiException,
                                                 IOException

Get a list of terminal models

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

Returns:

TerminalModelsResponse

Throws:

ApiException - if fails to make API call

IOException

listTerminalModels

public TerminalModelsResponse listTerminalModels(String merchantId,
                                                 RequestOptions requestOptions)
                                          throws ApiException,
                                                 IOException

Get a list of terminal models

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

TerminalModelsResponse

Throws:

ApiException - if fails to make API call

IOException

listTerminalProducts

public TerminalProductsResponse listTerminalProducts(String merchantId,
                                                     String country)
                                              throws ApiException,
                                                     IOException

Get a list of terminal products

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

country - String The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US** (required)

Returns:

TerminalProductsResponse

Throws:

ApiException - if fails to make API call

IOException

listTerminalProducts

public TerminalProductsResponse listTerminalProducts(String merchantId,
                                                     String country,
                                                     String terminalModelId,
                                                     Integer offset,
                                                     Integer limit,
                                                     RequestOptions requestOptions)
                                              throws ApiException,
                                                     IOException

Get a list of terminal products

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

country - String Query: The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US** (required)

terminalModelId - String Query: The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/merchants/{merchantId}/terminalModels) response. For example, **Verifone.M400** (optional)

offset - Integer Query: The number of products to skip. (optional)

limit - Integer Query: The number of products to return. (optional)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

TerminalProductsResponse

Throws:

ApiException - if fails to make API call

IOException

updateOrder

public TerminalOrder updateOrder(String merchantId,
                                 String orderId,
                                 TerminalOrderRequest terminalOrderRequest)
                          throws ApiException,
                                 IOException

Update an order

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

orderId - String The unique identifier of the order. (required)

terminalOrderRequest - TerminalOrderRequest (required)

Returns:

TerminalOrder

Throws:

ApiException - if fails to make API call

IOException

updateOrder

public TerminalOrder updateOrder(String merchantId,
                                 String orderId,
                                 TerminalOrderRequest terminalOrderRequest,
                                 RequestOptions requestOptions)
                          throws ApiException,
                                 IOException

Update an order

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

orderId - String The unique identifier of the order. (required)

terminalOrderRequest - TerminalOrderRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

TerminalOrder

Throws:

ApiException - if fails to make API call

IOException