Customer Service Center Data Resources

Each customizable area shows data from its default data source. For this data source, no configuration is necessary. If a customizable area shows (or modifies) data from different resource, that resource must be configured. To show other attributes from other data resources in vies or forms, the element data has to be added as a new top-level element.

In this data section, the additional attributes have to be configured accordingly.

1"attributes": {
2    "attributname": {
3        "read": {
4            "resource": "Resourcename",
5            "path": "attribute read path"
6        },
7        "write": {
8            "resource": "Resourcename",
9            "path": "attribute write path"
10        }
11    }
12}

The attribute read path can also contain XPath expressions and functions.

Example

An agent wants to check (and possibly modify) the customer’s email address when editing the basket billing address, because an email address is required for ordering. With customization of the basket billing address and by using a different resource (BasketCustomer, which provides the customer’s email address), the email address can be added to the configuration.

Because the CSC Basket Customer Info Data Provider takes care of metadata handling, the necessary type information is transferred accordingly. The attribute customeremail is available in attribute_layout or attribute_form widgets and can be edited while editing the billing address.

The following is a slightly stripped down billing address configuration:

1{
2  "data": {
3    "attributes": {
4      "customeremail": {
5        "read": {
6          "resource": "BasketCustomer",
7          "path": "/email"
8        },
9        "write": {
10          "resource": "BasketCustomer",
11          "path": "/email"
12        }
13      }
14    }
15  },
16  "layout": [
17    {
18      "condition": "data",
19      "layout": [
20        {
21          "id": "address",
22          "layout": [
23            {
24              "attribute": "customeremail", "width":12
25            },
26            {
27              "attribute": "first_name",
28              "meta": {
29                "maxLength": 50
30              },
31              "width": 6
32            },
33            {
34              "attribute": "last_name",
35              "meta": {
36                "maxLength": 50,
37                "required": true
38              },
39              "width": 6
40            },
41            {... more attributes... }
42          ]
43        }
44      ]
45    }
46  ],
47  "widgets": {
48    "address": {
49      "type": "attribute_form"
50    }
51  }
52}

The resulting billing address form contains now an email that is updated outside the actual billing address.

Area-Specific Data Sources


Customizable area	Default data source	Alternative data sources
Product Detail	BasketProduct	Basket Address, Customer Info, Basket
Basket Shipping Address	Basket Address	Customer Info, Basket
Basket Billing Address	Basket Address	Customer Info, Basket
Basket Billing Address View These customizable areas are also used to show a list of all basket addresses for selecting the billing or shipping address of a basket. The data source is Basket Addresses.	Basket Address	Customer Info, Basket
Basket Shipping Address View	Basket Address	Customer Info, Basket
Basket Payment Instrument	Basket Payment Instrument	Customer Info, Basket
Price Adjustment	Price Adjustment	Basket Address, Customer Info, Basket
Order Payment Instrument	Order Payment Instrument	Order Address, Order
Order Billing Address View	Order Address	Order
Order Shipping Address View	Order Address	Order

Basket

Provides data from a basket.

Name in configuration: Basket

Parameter:

Name	Meaning	Required?
basket_id	ID of the basket	yes

Basket Address

Provides data of an address of a basket.

Name in configuration: BasketAddress

Parameters:

Name	Meaning	Required?
basket_id	ID of the basket	yes
shipment_id	ID of the shipment to fetch the address from	no, the billing address is returned otherwise

Basket Payment Instrument

Provides data about the payment instrument.

Name in configuration: BasketPaymentInstrument

Parameters:

Name	Meaning	Required?
basket_id	ID of the basket	yes
payment_method_id	ID of the payment method to pay with	no
payment_card_type	type of the credit card to use	no
payment_instrument_id	ID of the payment instrument	no

Basket Product

Provides data of a product item.

Name in configuration: BasketProduct

Parameters:

Name	Meaning	Required?
basket_id	ID of the basket	yes
item_id	ID of the product item	no, if a product_id is given
product_id	ID of a product	yes, if no item_id is given

Customer Info

Provides data of a customer.

Name in configuration: BasketCustomer

Parameter:

Name	Meaning	Required?
basket_id	ID of the basket	yes

Order

Provides data from an order.

Name in configuration: Order

Parameter:

Name	Meaning	Required?
order_no	order number	yes

Order Address

Provides data of an address of an order.

Name in configuration: OrderAddress

Parameters:

Name	Meaning	Required?
order_no	order number	yes
shipment_id	ID of the shipment to fetch the address from	no, the billing address is returned otherwise

Order Payment Instrument

Provides data about the payment instrument of an order.

Name in configuration: OrderPaymentInstrument

Parameters:

Name	Meaning	Required?
order_no	order number	yes
payment_method_id	ID of the payment method to pay with	no
payment_card_type	type of the credit card to use	no
payment_instrument_id	ID of the payment instrument	no

For a provided payment_method_id, the payment_card_type is also considered and the data returned is as complete as possible:

a credit card payment method returns a partially filled out credit card object
a bank transfer payment method returns a partially filled out bank transfer object
a provided payment_instrument_id returns the data of the payment instrument

Price Adjustment

Provides data of a price adjustment.

Name in configuration: BasketPriceAdjustment

Parameter:

Name	Meaning	Required?
basket_id	ID of the basket	yes
item_id	ID of the product item	no, if a product_id is given

Generic Data Sources

Data source: site

Provides site information, the possible properties of the site object can be checked in the Site documentation from Shop API. Here is an example using name, id, and timezone properties.

1"data": {
2  "attributes": {
3    "sitename": {
4      "read": {
5        "resource": "Site",
6        "path": "/name"
7      }
8    },
9    "siteid": {
10      "read": {
11        "resource": "Site",
12        "path": "/id"
13      }
14    },
15    "sitetz": {
16      "read": {
17        "resource": "Site",
18        "path": "/timezone"
19      }
20    }
21  }
22},
23"layout": {
24  [{
25    "id": "siteinfo",
26    "condition": "data.siteid === 'SiteGenesis'",
27    "width": 12
28  }]
29},
30"widgets": {
31  "siteinfo": {
32    "type": "attribute_listing",
33    "config": {
34      "attributes": [
35        "sitename",
36        "siteid",
37        "sitetz"
38      ],
39      "columns": 2
40    }
41  }
42}