Package com.adyen.service.management

Class TerminalOrdersCompanyLevel

java.lang.Object

com.adyen.Service

com.adyen.ApiKeyAuthenticatedService

com.adyen.service.management.TerminalOrdersCompanyLevel

public class TerminalOrdersCompanyLevel
extends ApiKeyAuthenticatedService

Field Summary

Fields inherited from class com.adyen.Service

GSON

Constructor Summary

Constructors

Constructor	Description
TerminalOrdersCompanyLevel(Client client)

Method Summary

Modifier and Type	Method	Description
TerminalOrder	cancelOrder(String companyId, String orderId)	Cancel an order
TerminalOrder	createOrder(String companyId, TerminalOrderRequest terminalOrderRequest)	Create an order
ShippingLocation	createShippingLocation(String companyId, ShippingLocation shippingLocation)	Create a shipping location
TerminalOrder	getOrder(String companyId, String orderId)	Get an order
BillingEntitiesResponse	listBillingEntities(String companyId, Map<String,String> queryParams)	Get a list of billing entities
TerminalOrdersResponse	listOrders(String companyId, Map<String,String> queryParams)	Get a list of orders
ShippingLocationsResponse	listShippingLocations(String companyId, Map<String,String> queryParams)	Get a list of shipping locations
TerminalModelsResponse	listTerminalModels(String companyId)	Get a list of terminal models
TerminalProductsResponse	listTerminalProducts(String companyId, Map<String,String> queryParams)	Get a list of terminal products
TerminalOrder	updateOrder(String companyId, String orderId, TerminalOrderRequest terminalOrderRequest)	Update an order

Methods inherited from class com.adyen.Service

getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

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

Constructor Detail

TerminalOrdersCompanyLevel

public TerminalOrdersCompanyLevel(Client client)

Method Detail

listBillingEntities

public BillingEntitiesResponse listBillingEntities(String companyId,
                                                   Map<String,String> queryParams)
                                            throws ApiException,
                                                   IOException

Get a list of billing entities

Parameters:

companyId - The unique identifier of the company account. (required)

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

Returns:

BillingEntitiesResponse

Throws:

ApiException - if fails to make API call

IOException

listShippingLocations

public ShippingLocationsResponse listShippingLocations(String companyId,
                                                       Map<String,String> queryParams)
                                                throws ApiException,
                                                       IOException

Get a list of shipping locations

Parameters:

companyId - The unique identifier of the company account. (required)

queryParams - (optional) name: The name of the shipping location. (optional) offset: The number of locations to skip. (optional) limit: The number of locations to return. (optional)

Returns:

ShippingLocationsResponse

Throws:

ApiException - if fails to make API call

IOException

listTerminalModels

public TerminalModelsResponse listTerminalModels(String companyId)
                                          throws ApiException,
                                                 IOException

Get a list of terminal models

Parameters:

companyId - The unique identifier of the company account. (required)

Returns:

TerminalModelsResponse

Throws:

ApiException - if fails to make API call

IOException

listOrders

public TerminalOrdersResponse listOrders(String companyId,
                                         Map<String,String> queryParams)
                                  throws ApiException,
                                         IOException

Get a list of orders

Parameters:

companyId - The unique identifier of the company account. (required)

queryParams - (optional) customerOrderReference: Your purchase order number. (optional) status: The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered. (optional) offset: The number of orders to skip. (optional) limit: The number of orders to return. (optional)

Returns:

TerminalOrdersResponse

Throws:

ApiException - if fails to make API call

IOException

getOrder

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

Get an order

Parameters:

companyId - The unique identifier of the company account. (required)

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

Returns:

TerminalOrder

Throws:

ApiException - if fails to make API call

IOException

listTerminalProducts

public TerminalProductsResponse listTerminalProducts(String companyId,
                                                     Map<String,String> queryParams)
                                              throws ApiException,
                                                     IOException

Get a list of terminal products

Parameters:

companyId - The unique identifier of the company account. (required)

queryParams - (optional) country: 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** (optional) terminalModelId: The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/terminalModels) response. For example, **Verifone.M400** (optional) offset: The number of products to skip. (optional) limit: The number of products to return. (optional)

Returns:

TerminalProductsResponse

Throws:

ApiException - if fails to make API call

IOException

updateOrder

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

Update an order

Parameters:

companyId - The unique identifier of the company account. (required)

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

terminalOrderRequest - (optional)

Returns:

TerminalOrder

Throws:

ApiException - if fails to make API call

IOException

createShippingLocation

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

Create a shipping location

Parameters:

companyId - The unique identifier of the company account. (required)

shippingLocation - (optional)

Returns:

ShippingLocation

Throws:

ApiException - if fails to make API call

IOException

createOrder

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

Create an order

Parameters:

companyId - The unique identifier of the company account. (required)

terminalOrderRequest - (optional)

Returns:

TerminalOrder

Throws:

ApiException - if fails to make API call

IOException

cancelOrder

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

Cancel an order

Parameters:

companyId - The unique identifier of the company account. (required)

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

Returns:

TerminalOrder

Throws:

ApiException - if fails to make API call

IOException