Api

Class CustomerShippingAddressApi

java.lang.Object

Api.CustomerShippingAddressApi

public class CustomerShippingAddressApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomerShippingAddressApi()
CustomerShippingAddressApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteCustomerShippingAddress(String customerId, String shippingAddressId, String profileId) Delete a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a Customers Shipping Address**<br>Your system can use this API to delete an existing Shipping Address for a Customer.<br>If a customer has more than one Shipping Address then the default Shipping Address cannot be deleted without first selecting a [new default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body).
okhttp3.Call	deleteCustomerShippingAddressAsync(String customerId, String shippingAddressId, String profileId, ApiCallback<Void> callback) Delete a Customer Shipping Address (asynchronously) | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a Customers Shipping Address**<br>Your system can use this API to delete an existing Shipping Address for a Customer.<br>If a customer has more than one Shipping Address then the default Shipping Address cannot be deleted without first selecting a [new default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body).
okhttp3.Call	deleteCustomerShippingAddressCall(String customerId, String shippingAddressId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteCustomerShippingAddress
ApiResponse<Void>	deleteCustomerShippingAddressWithHttpInfo(String customerId, String shippingAddressId, String profileId) Delete a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a Customers Shipping Address**<br>Your system can use this API to delete an existing Shipping Address for a Customer.<br>If a customer has more than one Shipping Address then the default Shipping Address cannot be deleted without first selecting a [new default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body).
ApiClient	getApiClient()
PostCustomerShippingAddressRequest	getCustomerShippingAddress(String customerId, String shippingAddressId, String profileId) Retrieve a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Customer Shipping Address**<br>Your system can use this API to retrieve an existing Shipping Address for a Customer.<br>To perform a payment with a particular Shipping Address simply specify the [Shipping Address Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).
okhttp3.Call	getCustomerShippingAddressAsync(String customerId, String shippingAddressId, String profileId, ApiCallback<PostCustomerShippingAddressRequest> callback) Retrieve a Customer Shipping Address (asynchronously) | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Customer Shipping Address**<br>Your system can use this API to retrieve an existing Shipping Address for a Customer.<br>To perform a payment with a particular Shipping Address simply specify the [Shipping Address Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).
okhttp3.Call	getCustomerShippingAddressCall(String customerId, String shippingAddressId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getCustomerShippingAddress
ShippingAddressListForCustomer	getCustomerShippingAddressesList(String customerId, String profileId, Long offset, Long limit) List Shipping Addresses for a Customer | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Customer Shipping Addresses**<br>Your system can use this API to retrieve all existing Shipping Addresses for a Customer.
okhttp3.Call	getCustomerShippingAddressesListAsync(String customerId, String profileId, Long offset, Long limit, ApiCallback<ShippingAddressListForCustomer> callback) List Shipping Addresses for a Customer (asynchronously) | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Customer Shipping Addresses**<br>Your system can use this API to retrieve all existing Shipping Addresses for a Customer.
okhttp3.Call	getCustomerShippingAddressesListCall(String customerId, String profileId, Long offset, Long limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getCustomerShippingAddressesList
ApiResponse<ShippingAddressListForCustomer>	getCustomerShippingAddressesListWithHttpInfo(String customerId, String profileId, Long offset, Long limit) List Shipping Addresses for a Customer | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Customer Shipping Addresses**<br>Your system can use this API to retrieve all existing Shipping Addresses for a Customer.
ApiResponse<PostCustomerShippingAddressRequest>	getCustomerShippingAddressWithHttpInfo(String customerId, String shippingAddressId, String profileId) Retrieve a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Customer Shipping Address**<br>Your system can use this API to retrieve an existing Shipping Address for a Customer.<br>To perform a payment with a particular Shipping Address simply specify the [Shipping Address Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).
PatchCustomerShippingAddressRequest	patchCustomersShippingAddress(String customerId, String shippingAddressId, PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest, String profileId, String ifMatch) Update a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Customers Shipping Address**<br>Your system can use this API to update an existing Shipping Addresses for a Customer, including selecting a [default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body) for use in payments.
okhttp3.Call	patchCustomersShippingAddressAsync(String customerId, String shippingAddressId, PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest, String profileId, String ifMatch, ApiCallback<PatchCustomerShippingAddressRequest> callback) Update a Customer Shipping Address (asynchronously) | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Customers Shipping Address**<br>Your system can use this API to update an existing Shipping Addresses for a Customer, including selecting a [default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body) for use in payments.
okhttp3.Call	patchCustomersShippingAddressCall(String customerId, String shippingAddressId, PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest, String profileId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for patchCustomersShippingAddress
ApiResponse<PatchCustomerShippingAddressRequest>	patchCustomersShippingAddressWithHttpInfo(String customerId, String shippingAddressId, PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest, String profileId, String ifMatch) Update a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Customers Shipping Address**<br>Your system can use this API to update an existing Shipping Addresses for a Customer, including selecting a [default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body) for use in payments.
PostCustomerShippingAddressRequest	postCustomerShippingAddress(String customerId, PostCustomerShippingAddressRequest postCustomerShippingAddressRequest, String profileId) Create a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Creating a Customer Shipping Address**<br>Your system can use this API to create an existing Customers default or non default Shipping Address.<br>You can also create additional Customer Shipping Addresses via the [Payments API](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).
okhttp3.Call	postCustomerShippingAddressAsync(String customerId, PostCustomerShippingAddressRequest postCustomerShippingAddressRequest, String profileId, ApiCallback<PostCustomerShippingAddressRequest> callback) Create a Customer Shipping Address (asynchronously) | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Creating a Customer Shipping Address**<br>Your system can use this API to create an existing Customers default or non default Shipping Address.<br>You can also create additional Customer Shipping Addresses via the [Payments API](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).
okhttp3.Call	postCustomerShippingAddressCall(String customerId, PostCustomerShippingAddressRequest postCustomerShippingAddressRequest, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postCustomerShippingAddress
ApiResponse<PostCustomerShippingAddressRequest>	postCustomerShippingAddressWithHttpInfo(String customerId, PostCustomerShippingAddressRequest postCustomerShippingAddressRequest, String profileId) Create a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Creating a Customer Shipping Address**<br>Your system can use this API to create an existing Customers default or non default Shipping Address.<br>You can also create additional Customer Shipping Addresses via the [Payments API](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomerShippingAddressApi

public CustomerShippingAddressApi()

CustomerShippingAddressApi

public CustomerShippingAddressApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteCustomerShippingAddressCall

public okhttp3.Call deleteCustomerShippingAddressCall(String customerId,
                                                      String shippingAddressId,
                                                      String profileId,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for deleteCustomerShippingAddress

Parameters:

customerId - The Id of a Customer. (required)

shippingAddressId - The Id of a shipping address. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteCustomerShippingAddress

public void deleteCustomerShippingAddress(String customerId,
                                          String shippingAddressId,
                                          String profileId)
                                   throws ApiException

Delete a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a Customers Shipping Address**<br>Your system can use this API to delete an existing Shipping Address for a Customer.<br>If a customer has more than one Shipping Address then the default Shipping Address cannot be deleted without first selecting a [new default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

shippingAddressId - The Id of a shipping address. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteCustomerShippingAddressWithHttpInfo

public ApiResponse<Void> deleteCustomerShippingAddressWithHttpInfo(String customerId,
                                                                   String shippingAddressId,
                                                                   String profileId)
                                                            throws ApiException

Delete a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a Customers Shipping Address**<br>Your system can use this API to delete an existing Shipping Address for a Customer.<br>If a customer has more than one Shipping Address then the default Shipping Address cannot be deleted without first selecting a [new default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

shippingAddressId - The Id of a shipping address. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteCustomerShippingAddressAsync

public okhttp3.Call deleteCustomerShippingAddressAsync(String customerId,
                                                       String shippingAddressId,
                                                       String profileId,
                                                       ApiCallback<Void> callback)
                                                throws ApiException

Delete a Customer Shipping Address (asynchronously) | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a Customers Shipping Address**<br>Your system can use this API to delete an existing Shipping Address for a Customer.<br>If a customer has more than one Shipping Address then the default Shipping Address cannot be deleted without first selecting a [new default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

shippingAddressId - The Id of a shipping address. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getCustomerShippingAddressCall

public okhttp3.Call getCustomerShippingAddressCall(String customerId,
                                                   String shippingAddressId,
                                                   String profileId,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getCustomerShippingAddress

Parameters:

customerId - The Id of a Customer. (required)

shippingAddressId - The Id of a shipping address. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCustomerShippingAddress

public PostCustomerShippingAddressRequest getCustomerShippingAddress(String customerId,
                                                                     String shippingAddressId,
                                                                     String profileId)
                                                              throws ApiException

Retrieve a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Customer Shipping Address**<br>Your system can use this API to retrieve an existing Shipping Address for a Customer.<br>To perform a payment with a particular Shipping Address simply specify the [Shipping Address Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

shippingAddressId - The Id of a shipping address. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

Returns:

PostCustomerShippingAddressRequest

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCustomerShippingAddressWithHttpInfo

public ApiResponse<PostCustomerShippingAddressRequest> getCustomerShippingAddressWithHttpInfo(String customerId,
                                                                                              String shippingAddressId,
                                                                                              String profileId)
                                                                                       throws ApiException

Retrieve a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Customer Shipping Address**<br>Your system can use this API to retrieve an existing Shipping Address for a Customer.<br>To perform a payment with a particular Shipping Address simply specify the [Shipping Address Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

shippingAddressId - The Id of a shipping address. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

Returns:

ApiResponse<PostCustomerShippingAddressRequest>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCustomerShippingAddressAsync

public okhttp3.Call getCustomerShippingAddressAsync(String customerId,
                                                    String shippingAddressId,
                                                    String profileId,
                                                    ApiCallback<PostCustomerShippingAddressRequest> callback)
                                             throws ApiException

Retrieve a Customer Shipping Address (asynchronously) | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Customer Shipping Address**<br>Your system can use this API to retrieve an existing Shipping Address for a Customer.<br>To perform a payment with a particular Shipping Address simply specify the [Shipping Address Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

shippingAddressId - The Id of a shipping address. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getCustomerShippingAddressesListCall

public okhttp3.Call getCustomerShippingAddressesListCall(String customerId,
                                                         String profileId,
                                                         Long offset,
                                                         Long limit,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for getCustomerShippingAddressesList

Parameters:

customerId - The Id of a Customer. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)

limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCustomerShippingAddressesList

public ShippingAddressListForCustomer getCustomerShippingAddressesList(String customerId,
                                                                       String profileId,
                                                                       Long offset,
                                                                       Long limit)
                                                                throws ApiException

List Shipping Addresses for a Customer | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Customer Shipping Addresses**<br>Your system can use this API to retrieve all existing Shipping Addresses for a Customer.

Parameters:

customerId - The Id of a Customer. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)

limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)

Returns:

ShippingAddressListForCustomer

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCustomerShippingAddressesListWithHttpInfo

public ApiResponse<ShippingAddressListForCustomer> getCustomerShippingAddressesListWithHttpInfo(String customerId,
                                                                                                String profileId,
                                                                                                Long offset,
                                                                                                Long limit)
                                                                                         throws ApiException

List Shipping Addresses for a Customer | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Customer Shipping Addresses**<br>Your system can use this API to retrieve all existing Shipping Addresses for a Customer.

Parameters:

customerId - The Id of a Customer. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)

limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)

Returns:

ApiResponse<ShippingAddressListForCustomer>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCustomerShippingAddressesListAsync

public okhttp3.Call getCustomerShippingAddressesListAsync(String customerId,
                                                          String profileId,
                                                          Long offset,
                                                          Long limit,
                                                          ApiCallback<ShippingAddressListForCustomer> callback)
                                                   throws ApiException

List Shipping Addresses for a Customer (asynchronously) | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Customer Shipping Addresses**<br>Your system can use this API to retrieve all existing Shipping Addresses for a Customer.

Parameters:

customerId - The Id of a Customer. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

offset - Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)

limit - The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

patchCustomersShippingAddressCall

public okhttp3.Call patchCustomersShippingAddressCall(String customerId,
                                                      String shippingAddressId,
                                                      PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
                                                      String profileId,
                                                      String ifMatch,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for patchCustomersShippingAddress

Parameters:

customerId - The Id of a Customer. (required)

shippingAddressId - The Id of a shipping address. (required)

patchCustomerShippingAddressRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

patchCustomersShippingAddress

public PatchCustomerShippingAddressRequest patchCustomersShippingAddress(String customerId,
                                                                         String shippingAddressId,
                                                                         PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
                                                                         String profileId,
                                                                         String ifMatch)
                                                                  throws ApiException

Update a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Customers Shipping Address**<br>Your system can use this API to update an existing Shipping Addresses for a Customer, including selecting a [default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body) for use in payments.

Parameters:

customerId - The Id of a Customer. (required)

shippingAddressId - The Id of a shipping address. (required)

patchCustomerShippingAddressRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)

Returns:

PatchCustomerShippingAddressRequest

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

patchCustomersShippingAddressWithHttpInfo

public ApiResponse<PatchCustomerShippingAddressRequest> patchCustomersShippingAddressWithHttpInfo(String customerId,
                                                                                                  String shippingAddressId,
                                                                                                  PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
                                                                                                  String profileId,
                                                                                                  String ifMatch)
                                                                                           throws ApiException

Update a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Customers Shipping Address**<br>Your system can use this API to update an existing Shipping Addresses for a Customer, including selecting a [default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body) for use in payments.

Parameters:

customerId - The Id of a Customer. (required)

shippingAddressId - The Id of a shipping address. (required)

patchCustomerShippingAddressRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)

Returns:

ApiResponse<PatchCustomerShippingAddressRequest>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

patchCustomersShippingAddressAsync

public okhttp3.Call patchCustomersShippingAddressAsync(String customerId,
                                                       String shippingAddressId,
                                                       PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
                                                       String profileId,
                                                       String ifMatch,
                                                       ApiCallback<PatchCustomerShippingAddressRequest> callback)
                                                throws ApiException

Update a Customer Shipping Address (asynchronously) | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Customers Shipping Address**<br>Your system can use this API to update an existing Shipping Addresses for a Customer, including selecting a [default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body) for use in payments.

Parameters:

customerId - The Id of a Customer. (required)

shippingAddressId - The Id of a shipping address. (required)

patchCustomerShippingAddressRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

postCustomerShippingAddressCall

public okhttp3.Call postCustomerShippingAddressCall(String customerId,
                                                    PostCustomerShippingAddressRequest postCustomerShippingAddressRequest,
                                                    String profileId,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for postCustomerShippingAddress

Parameters:

customerId - The Id of a Customer. (required)

postCustomerShippingAddressRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postCustomerShippingAddress

public PostCustomerShippingAddressRequest postCustomerShippingAddress(String customerId,
                                                                      PostCustomerShippingAddressRequest postCustomerShippingAddressRequest,
                                                                      String profileId)
                                                               throws ApiException

Create a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Creating a Customer Shipping Address**<br>Your system can use this API to create an existing Customers default or non default Shipping Address.<br>You can also create additional Customer Shipping Addresses via the [Payments API](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

postCustomerShippingAddressRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

Returns:

PostCustomerShippingAddressRequest

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

postCustomerShippingAddressWithHttpInfo

public ApiResponse<PostCustomerShippingAddressRequest> postCustomerShippingAddressWithHttpInfo(String customerId,
                                                                                               PostCustomerShippingAddressRequest postCustomerShippingAddressRequest,
                                                                                               String profileId)
                                                                                        throws ApiException

Create a Customer Shipping Address | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Creating a Customer Shipping Address**<br>Your system can use this API to create an existing Customers default or non default Shipping Address.<br>You can also create additional Customer Shipping Addresses via the [Payments API](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

postCustomerShippingAddressRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

Returns:

ApiResponse<PostCustomerShippingAddressRequest>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

postCustomerShippingAddressAsync

public okhttp3.Call postCustomerShippingAddressAsync(String customerId,
                                                     PostCustomerShippingAddressRequest postCustomerShippingAddressRequest,
                                                     String profileId,
                                                     ApiCallback<PostCustomerShippingAddressRequest> callback)
                                              throws ApiException

Create a Customer Shipping Address (asynchronously) | | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Creating a Customer Shipping Address**<br>Your system can use this API to create an existing Customers default or non default Shipping Address.<br>You can also create additional Customer Shipping Addresses via the [Payments API](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).

Parameters:

customerId - The Id of a Customer. (required)

postCustomerShippingAddressRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object