| Package | Description |
|---|---|
| Api | |
| Model |
| Modifier and Type | Method and Description |
|---|---|
Tmsv2customersEmbeddedDefaultShippingAddress |
CustomerShippingAddressApi.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.| |**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).
|
Tmsv2customersEmbeddedDefaultShippingAddress |
CustomerShippingAddressApi.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.| |**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.
|
Tmsv2customersEmbeddedDefaultShippingAddress |
CustomerShippingAddressApi.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.| |**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).
|
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress> |
CustomerShippingAddressApi.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.| |**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).
|
ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress> |
CustomerShippingAddressApi.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.| |**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.
|
ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress> |
CustomerShippingAddressApi.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.| |**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).
|
| Modifier and Type | Method and Description |
|---|---|
okhttp3.Call |
CustomerShippingAddressApi.getCustomerShippingAddressAsync(String customerId,
String shippingAddressId,
String profileId,
ApiCallback<Tmsv2customersEmbeddedDefaultShippingAddress> 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.| |**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 |
CustomerShippingAddressApi.patchCustomersShippingAddressAsync(String customerId,
String shippingAddressId,
PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
String profileId,
String ifMatch,
ApiCallback<Tmsv2customersEmbeddedDefaultShippingAddress> 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.| |**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 |
CustomerShippingAddressApi.postCustomerShippingAddressAsync(String customerId,
PostCustomerShippingAddressRequest postCustomerShippingAddressRequest,
String profileId,
ApiCallback<Tmsv2customersEmbeddedDefaultShippingAddress> 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.| |**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).
|
| Modifier and Type | Method and Description |
|---|---|
Tmsv2customersEmbeddedDefaultShippingAddress |
Tmsv2customersEmbeddedDefaultShippingAddress._default(Boolean _default) |
Tmsv2customersEmbeddedDefaultShippingAddress |
Tmsv2customersEmbedded.getDefaultShippingAddress()
Get defaultShippingAddress
|
Tmsv2customersEmbeddedDefaultShippingAddress |
Tmsv2customersEmbeddedDefaultShippingAddress.id(String id) |
Tmsv2customersEmbeddedDefaultShippingAddress |
Tmsv2customersEmbeddedDefaultShippingAddress.links(Tmsv2customersEmbeddedDefaultShippingAddressLinks links) |
Tmsv2customersEmbeddedDefaultShippingAddress |
Tmsv2customersEmbeddedDefaultShippingAddress.metadata(Tmsv2customersEmbeddedDefaultShippingAddressMetadata metadata) |
Tmsv2customersEmbeddedDefaultShippingAddress |
Tmsv2customersEmbeddedDefaultShippingAddress.shipTo(Tmsv2customersEmbeddedDefaultShippingAddressShipTo shipTo) |
| Modifier and Type | Method and Description |
|---|---|
List<Tmsv2customersEmbeddedDefaultShippingAddress> |
ShippingAddressListForCustomerEmbedded.getShippingAddresses()
Get shippingAddresses
|
| Modifier and Type | Method and Description |
|---|---|
ShippingAddressListForCustomerEmbedded |
ShippingAddressListForCustomerEmbedded.addShippingAddressesItem(Tmsv2customersEmbeddedDefaultShippingAddress shippingAddressesItem) |
Tmsv2customersEmbedded |
Tmsv2customersEmbedded.defaultShippingAddress(Tmsv2customersEmbeddedDefaultShippingAddress defaultShippingAddress) |
void |
Tmsv2customersEmbedded.setDefaultShippingAddress(Tmsv2customersEmbeddedDefaultShippingAddress defaultShippingAddress) |
| Modifier and Type | Method and Description |
|---|---|
void |
ShippingAddressListForCustomerEmbedded.setShippingAddresses(List<Tmsv2customersEmbeddedDefaultShippingAddress> shippingAddresses) |
ShippingAddressListForCustomerEmbedded |
ShippingAddressListForCustomerEmbedded.shippingAddresses(List<Tmsv2customersEmbeddedDefaultShippingAddress> shippingAddresses) |
Copyright © 2024. All rights reserved.