Documentation Index

Fetch the complete documentation index at: https://docs.newstore.com/llms.txt

Use this file to discover all available pages before exploring further.

Used Newie, our AI search tool in the docs? Take a 2-minute survey to rate your experience!

Adding webview customizations for customer profile locations

Prev Next

When adding a webview customization  for one of the customer profile locations, the URL fetches the data as configured in the following JSON schemas:

Note

The keys in the contextProps.formData object are not hard coded by NewStore and can be configured by the retailer.

Customer Profile (Create/Edit) - Extended Attributes

Extended Attributes in contextProps.formData as key-value map


{
  "contextProps": {
    "formData": {
      "emailOptin": "true",
      "favoriteColor": "Blue",
      "associateId": "1db2a42d-e872-432a-a87f-ed0964efc8d2",
      "storeId": "d4acdd7f-b6ef-4c4a-b229-250d60e745fb",
      "cartId": "d816a750-bcdf-4858-bca4-adca283be8b3",
    }
  },
  "externalIdentity": "secret-token-123",
}

Customer Profile (Overview) - Extended Attributes

Extended Attributes in contextProps.formData as key value map


{
  "contextProps": {
    "formData": {
      "emailOptin": "true",
      "favoriteColor": "Blue",
      "associateId": "1db2a42d-e872-432a-a87f-ed0964efc8d2",
      "storeId": "d4acdd7f-b6ef-4c4a-b229-250d60e745fb",
      "cartId": "d816a750-bcdf-4858-bca4-adca283be8b3",
    }
  },
  "externalIdentity": "secret-token-123",
}

Customer Profile (Overview) - Profile Identifier

Profile ID (UUID) of the customer in contextProps.formData


{
  "contextProps": {
    "formData": {
      "profileId": "6e8f3f23-117e-481c-b99e-7440f07b4960",
      "associateId": "1db2a42d-e872-432a-a87f-ed0964efc8d2",
      "storeId": "d4acdd7f-b6ef-4c4a-b229-250d60e745fb",
      "cartId": "d816a750-bcdf-4858-bca4-adca283be8b3",
    }
  },
  "externalIdentity": "secret-token-123",
}

Display modes

Like all webview customizations, customer profile webviews can be configured as:

  • Full-screen (default) — Opens as a new screen when the associate taps the customization button.

  • Inline — Rendered directly within the customer profile screen. Set meta.inline: true in the configuration, along with meta.height (pixels), and optionally meta.scrollEnabled, meta.scrollXEnabled, meta.scrollYEnabled .

Available from Associate App v1.83.0

An inline webview displays a header with the configured title and a button (labeled with caption) that opens the same page in full-screen mode. To hide that button and keep the webview inline-only, set meta.allowExpansion: false. The allowExpansion property defaults to true. Only an explicit false value hides the button.

For the full display mode reference and code examples, see Adding webview customizations to the product detail page.