API Docs for:
Show:

eb_BillingShippingAddressAdmin Class

Define eb_BillingShippingAddressAdmin class.

Item Index

Methods

eb_BillingShippingAddressAdmin.createAddressRecord

(
  • companyId
  • data
)
Object

POST service call method.

Parameters:

  • companyId Number

    companyId

  • data Object

    Address related information[ State, City, Country ...]

Returns:

Object:

New address promise object with City, Id, Country, State, line1, line2, name, postal code, StateProvience fields.

eb_BillingShippingAddressAdmin.deleteCompanyAddressRecord

(
  • companyId
  • addressName
)

Delete custom Company Address Service call

Parameters:

  • companyId Number

    companyID

  • addressName String

    Address name to delete particular address

eb_BillingShippingAddressAdmin.deleteCompanyProfileAddressRecord

(
  • companyId
  • addressName
)

Delete Company Profile Address Service call

Parameters:

  • companyId Number

    companyID

  • addressName String

    Address name to delete particular address

eb_BillingShippingAddressAdmin.domElement

(
  • domElement
)

Page DOM element.

Parameters:

  • domElement Object

    current DOM element.

eb_BillingShippingAddressAdmin.getAllShipmentTypes

() Object

Gets all web-enabled shipment types.

Returns:

Object:

jQuery promise object which when resolved returns shipment type list.

eb_BillingShippingAddressAdmin.getCompanyAddresses

(
  • companyId
)
Object

Public method to get custom Company Addresses data list from the server

Parameters:

  • companyId Number

    companyId to get company addresses

Returns:

Object:

Addresses of company

eb_BillingShippingAddressAdmin.getCompanyProfileAddresses

(
  • companyId
)
Object

Public method to get Profile Addresses data list from the server

Parameters:

  • companyId Number

    companyId to get profile addresses

Returns:

Object:

Addresses of person

eb_BillingShippingAddressAdmin.getCountriesData

() Object

Public method to get countries data list from the server.

Returns:

Object:

Return Array of All Countries

eb_BillingShippingAddressAdmin.getProvinceData

(
  • country
)
Object

Get State/Province list from the server through the get service call.

Parameters:

  • country String

    All the state in specified country

Returns:

Object:

Return Array of state

eb_BillingShippingAddressAdmin.model

(
  • options
)

BillingShippingAddressAdmin Model for binding data. The model contains observable properties to hold corresponding data returned from services. Also, model contains computed properties and methods to support Billing and Shipping Address functionality.

Parameters:

  • options Object

    Contains necessary data which is required for Billing and Shipping Address functionality.

    • ServicePath String

      Service URL.

    • SitePath String

      Site URL.

    • data Object

      Contains data returned from service which is used to construct BillingShippingAddress model.

    • domElement Object

      DOM element.

    • templatePath String

      HTML path.

eb_BillingShippingAddressAdmin.render

(
  • options
)
String

Rendering public method to load HTML template. Based on page level configuration it will select the template and load in DOM. Template path and DOM element are required parameters. GET the template by Ajax call using template path and then assign it to DOM element.

Parameters:

  • options Object

    Object with data required for getting HTML template through Ajax call.

    • SitePath String

      Site path.

    • templatePath String

      HTML file path.

    • domElement Object

      DOM element.

Returns:

String:

jQuery promise object which when resolved returns HTML template.

eb_BillingShippingAddressAdmin.shoppingCart

(
  • shoppingCart
)

Shopping cart object

Parameters:

  • shoppingCart Object

    shopping cart object.

eb_BillingShippingAddressAdmin.updateCompanyAddressRecord

(
  • companyId
  • data
  • addressName
)
Object

PATCH service call method.

Parameters:

  • companyId Number

    companyId

  • data Object

    Address related information[ State, City, Country ...]

  • addressName String

    Updated information of company Address

Returns:

Object:

Return Updated Address

eb_BillingShippingAddressAdmin.updateCompanyProfileAddressRecord

(
  • companyId
  • data
  • addressName
)
Object

PATCH service call method.

Parameters:

  • companyId Number

    companyId

  • data Object

    Address related information[ State, City, Country ...]

  • addressName String

    Updated information of profile address

Returns:

Object:

Return Updated Address

eb_BillingShippingAddressAdmin.userContext

(
  • userContext
)

User context object

Parameters:

  • userContext Object

    userContext object.

Properties

eb_BillingShippingAddressAdmin.companyId

String

Company Id

eb_BillingShippingAddressAdmin.defaultErrorMessage

String

Default error message.

eb_BillingShippingAddressAdmin.deleteCompanyAddressService

String

Delete company's custom address

eb_BillingShippingAddressAdmin.deleteProfileAddressService

String

Delete company's profile address

eb_BillingShippingAddressAdmin.errorResponses

Object

Globally defined error codes object for the control. Every error code should have boolean 'useServerMessage' attribute, which when true suggests we are showing service error message on the UI. If the 'useServerMessage' is defined as false, then provide another attribute 'frontEndMessage' with the error string which will be shown on UI. If 'useServerMessage' is false and 'frontEndMessage' is not defined, default error message will be shown. If service error response contains error code not defined in this object then default error message will be shown.

eb_BillingShippingAddressAdmin.getAllShipmentTypesURL

String

Get All Shipment types service URL.

eb_BillingShippingAddressAdmin.getCompanyAddressService

String

GET company's custom address service.

eb_BillingShippingAddressAdmin.getCompanyProfileAddressService

String

GET company's profile address service.

eb_BillingShippingAddressAdmin.getCountriesService

String

GET service to get all countries records.

eb_BillingShippingAddressAdmin.getProvinceService

String

GET service to get all State/Province record.

eb_BillingShippingAddressAdmin.newAddressService

String

GET new address service.

eb_BillingShippingAddressAdmin.orderReviewUrl

String

Redirect to review order Page.

eb_BillingShippingAddressAdmin.selectedAddress

String

Redirect to billing or shipping address

eb_BillingShippingAddressAdmin.ServicePath

String

The path to the eBusiness SOA layer.

eb_BillingShippingAddressAdmin.shippingAddress

String

Shipping Address

eb_BillingShippingAddressAdmin.SitePath

String

Control level setting: Site path.

eb_BillingShippingAddressAdmin.skipPageRedirection

Bool

skipPageRedirection

eb_BillingShippingAddressAdmin.TemplatePath

String

Control level setting Template path.

eb_BillingShippingAddressAdmin.updateCompanyAddressService

String

Update company's custom address service.

eb_BillingShippingAddressAdmin.updateCompanyProfileAddressService

String

Update company's profile address service.