UNPKG

sfcc-dev-mcp

Version:

MCP server for Salesforce B2C Commerce Cloud development assistance including logs, debugging, and development tools

366 lines (184 loc) 6.06 kB
## Package: dw.order # Class ShippingLocation ## Inheritance Hierarchy - Object - dw.order.ShippingLocation ## Description Represents a specific location for a shipment. Note: this class allows access to sensitive personal and private information. Pay attention to appropriate legal and regulatory requirements related to this data. ## Properties ### address1 **Type:** String The shipping location's first address. ### address2 **Type:** String The shipping location's second address. ### city **Type:** String The shipping location's city. ### countryCode **Type:** String The shipping location's country code. ### postalCode **Type:** String The shipping location's postal code. ### postBox **Type:** String The shipping location's post box. ### stateCode **Type:** String The shipping location's state code. ### suite **Type:** String The shipping location's suite. ## Constructor Summary ShippingLocation() Constructs a new shipping location. ShippingLocation(address : CustomerAddress) Constructs a new shipping location and initializes it with the values of the specified address object. ShippingLocation(address : OrderAddress) Constructs a new shipping location and initializes it with the values of the specified address object. ## Method Summary ### getAddress1 **Signature:** `getAddress1() : String` Returns the shipping location's first address. ### getAddress2 **Signature:** `getAddress2() : String` Returns the shipping location's second address. ### getCity **Signature:** `getCity() : String` Returns the shipping location's city. ### getCountryCode **Signature:** `getCountryCode() : String` Returns the shipping location's country code. ### getPostalCode **Signature:** `getPostalCode() : String` Returns the shipping location's postal code. ### getPostBox **Signature:** `getPostBox() : String` Returns the shipping location's post box. ### getStateCode **Signature:** `getStateCode() : String` Returns the shipping location's state code. ### getSuite **Signature:** `getSuite() : String` Returns the shipping location's suite. ### setAddress1 **Signature:** `setAddress1(aValue : String) : void` Sets the shipping location's first address. ### setAddress2 **Signature:** `setAddress2(aValue : String) : void` Sets the shipping location's second address. ### setCity **Signature:** `setCity(aValue : String) : void` Sets the shipping location's city. ### setCountryCode **Signature:** `setCountryCode(aValue : String) : void` Sets the shipping location's country code. ### setPostalCode **Signature:** `setPostalCode(aValue : String) : void` Sets the shipping location's postal code. ### setPostBox **Signature:** `setPostBox(aValue : String) : void` Sets the shipping location's post box. ### setStateCode **Signature:** `setStateCode(aValue : String) : void` Sets the shipping location's state code. ### setSuite **Signature:** `setSuite(aValue : String) : void` Sets the shipping location's suite. ## Constructor Detail ## Method Detail ## Method Details ### getAddress1 **Signature:** `getAddress1() : String` **Description:** Returns the shipping location's first address. **Returns:** the shipping location's first address. --- ### getAddress2 **Signature:** `getAddress2() : String` **Description:** Returns the shipping location's second address. **Returns:** the shipping location's second address. --- ### getCity **Signature:** `getCity() : String` **Description:** Returns the shipping location's city. **Returns:** the shipping location's city. --- ### getCountryCode **Signature:** `getCountryCode() : String` **Description:** Returns the shipping location's country code. **Returns:** the shipping location's country code. --- ### getPostalCode **Signature:** `getPostalCode() : String` **Description:** Returns the shipping location's postal code. **Returns:** the shipping location's postal code. --- ### getPostBox **Signature:** `getPostBox() : String` **Description:** Returns the shipping location's post box. **Returns:** the shipping location's post box. --- ### getStateCode **Signature:** `getStateCode() : String` **Description:** Returns the shipping location's state code. **Returns:** the shipping location's state code. --- ### getSuite **Signature:** `getSuite() : String` **Description:** Returns the shipping location's suite. **Returns:** the shipping location's suite. --- ### setAddress1 **Signature:** `setAddress1(aValue : String) : void` **Description:** Sets the shipping location's first address. **Parameters:** - `aValue`: the shipping location's first address. --- ### setAddress2 **Signature:** `setAddress2(aValue : String) : void` **Description:** Sets the shipping location's second address. **Parameters:** - `aValue`: the shipping location's second address. --- ### setCity **Signature:** `setCity(aValue : String) : void` **Description:** Sets the shipping location's city. **Parameters:** - `aValue`: the shipping location's city. --- ### setCountryCode **Signature:** `setCountryCode(aValue : String) : void` **Description:** Sets the shipping location's country code. **Parameters:** - `aValue`: the shipping location's country code. --- ### setPostalCode **Signature:** `setPostalCode(aValue : String) : void` **Description:** Sets the shipping location's postal code. **Parameters:** - `aValue`: the shipping location's postal code. --- ### setPostBox **Signature:** `setPostBox(aValue : String) : void` **Description:** Sets the shipping location's post box. **Parameters:** - `aValue`: the shipping location's post box. --- ### setStateCode **Signature:** `setStateCode(aValue : String) : void` **Description:** Sets the shipping location's state code. **Parameters:** - `aValue`: the shipping location's state code. --- ### setSuite **Signature:** `setSuite(aValue : String) : void` **Description:** Sets the shipping location's suite. **Parameters:** - `aValue`: the shipping location's suite. ---