Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
AbstractTransactionResponse Class
AddressesResponse Class
AddressesResponse Methods
AddressResponse Class
AmountDetailsResponse Class
CalculateTaxRequest Class
CalculateTaxResponse Class
CalculateTaxType Enum
ErrorResponse Class
HeaderTaxAddressesRequest Class
ImpositionResponse Class
JurisdictionResponse Class
LineItemResponse Class
LineTaxAddressesRequest Class
RequestType Enum
ResultCode Enum
RuleDetailsResponse Class
TaxAddressesRequest Class
TaxAddressRequest Class
TaxApiException Class
TaxCustomerDetailsRequest Class
TaxDetailsResponse Class
TaxEngineAdapter Interface
TaxEngineContext Class
TaxLineItemRequest Class
TaxSellerDetailsRequest Class
TaxTransactionRequest Class
TaxTransactionStatus Enum
TaxTransactionType Enum
Compression Namespace (Developer Preview)
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace (Beta)
fsccashflow Namespace
Functions Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RichMessaging Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

AddressesResponse Class

Sets the tax address fields based on a response from the external tax engine. Contains setter methods for the Ship From, Ship To, and Sold To addresses.

Namespace

CommerceTax

Usage

Because AddressesResponse contains multiple addresses, we recommend using multiple instances of AddressResponse to set unique values for each address.

Example

This code sample represents a portion of the code used in a mock tax adapter. In this example, you create three AddressResponse classes, set their location codes, and pass them to the Ship To, Ship From, and Sold To setter methods in AddressesResponse. In an actual implementation, your AddressResponse classes already have a location code based on the response from the external tax engine.

1commercetax.AddressesResponse addressesRes = new commercetax.AddressesResponse();
2
3//AddressResponse containing ShipTo information
4commercetax.AddressResponse shipToAddress = new commercetax.AddressResponse();
5shipToAddress.setLocationCode('1234567');
6
7//AddressResponse containing ShipFrom information
8commercetax.AddressResponse shipFromAddress = new commercetax.AddressResponse();
9shipFromAddress.setLocationCode('84720385');
10
11//AddressResponse containing Sold To information
12commercetax.AddressResponse soldToAddress = new commercetax.AddressResponse();
13soldToAddress.setLocationCode('92381749');
14
15//set values of addressesRes
16addressesRes.setShipFrom(shipFromAddress);
17addressesRes.setShipTo(shipToAddress);
18addressesRes.setSoldTo(soldToAddress);

AddressesResponse Methods

Learn more about the methods for AddressesResponse class.

The AddressesResponse class includes these methods.

setShipFrom(shipFrom)

Sets the value of a ShipFrom address field.

Signature

global void setShipFrom(commercetax.AddressResponse shipFrom)

Parameters

shipFrom
Type: AddressResponse
A single address. Use this generic address parameter to store any type of address, such as Ship From, Ship To, and Sold To details. Users set the specific address in an AddressResponse instance and then pass that instance to the AddressesResponse’s setShipTo(), setShipFrom(), and setSoldTo() methods as needed.

Return Value

Type: void

setShipTo(shipTo)

Sets the value of a ShipTo address field.

Signature

global void setShipTo(commercetax.AddressResponse shipTo)

Parameters

shipTo
Type: AddressResponse
Stores a single address. This is a generic address parameter and can be used to store any type of address, such as Ship From, Ship To, and Sold To details. Users set the specific address in an AddressResponse instance and then pass that instance to the AddressesResponse’s setShipTo(), setShipFrom(), and setSoldTo() methods as needed.

Return Value

Type: void

setSoldTo(soldTo)

Sets the value of a SoldTo address field.

Signature

global void setSoldTo(commercetax.AddressResponse soldTo)

Parameters

soldTo
Type: AddressResponse
Stores a single address. This is a generic address parameter and can be used to store any type of address, such as Ship From, Ship To, Sold To details. Users set the specific address in an AddressResponse instance and then pass that instance to the AddressesResponse’s setShipTo(), setShipFrom(), and setSoldTo() methods as needed.

Return Value

Type: void