Customer Service Center Data Resources

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:

{
  "data": {
    "attributes": {
      "customeremail": {
        "read": {
          "resource": "BasketCustomer",
          "path": "/email"
        },
        "write": {
          "resource": "BasketCustomer",
          "path": "/email"
        }
      }
    }
  },
  "layout": [
    {
      "condition": "data",
      "layout": [
        {
          "id": "address",
          "layout": [
            {
              "attribute": "customeremail", "width":12
            },
            {
              "attribute": "first_name",
              "meta": {
                "maxLength": 50
              },
              "width": 6
            },
            {
              "attribute": "last_name",
              "meta": {
                "maxLength": 50,
                "required": true
              },
              "width": 6
            },
            {... more attributes... }
          ]
        }
      ]
    }
  ],
  "widgets": {
    "address": {
      "type": "attribute_form"
    }
  }
}

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

Area-Specific Data Sources

• 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

  Parameter:

  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

  Parameter

  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

  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
  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

  Parameter:

  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

  Parameter:

  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.

"data": {
    "attributes": {
      "sitename": {
        "read": {
          "resource": "Site",
          "path": "/name"
        }
      },
      "siteid": {
        "read": {
          "resource": "Site",
          "path": "/id"
        }
      },
      "sitetz": {
        "read": {
          "resource": "Site",
          "path": "/timezone"
        }
      }
    }
  }
  
"layout": {
            [{
              "id": "siteinfo",
              "condition": "data.siteid === 'SiteGenesis'",
              "width": 12
            }]
}
  
"widgets": {
    "siteinfo": {
      "type": "attribute_listing",
      "config": {
        "attributes": [
          "sitename",
          "siteid",
          "sitetz"
        ],
        "columns": 2
      }
    }
}