Skip to content

Commit 9c400d3

Browse files
authored
Update index.md
1 parent c07844e commit 9c400d3

File tree

1 file changed

+15
-13
lines changed
  • src/connections/sources/catalog/cloud-apps/elastic-path

1 file changed

+15
-13
lines changed

src/connections/sources/catalog/cloud-apps/elastic-path/index.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
22
title: Elastic Path Source
3+
hidden: true
34
---
45

56
[Elastic Path](https://www.elasticpath.com?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a SaaS based headless commerce platform that provides core commerce with a focus on catalog & product data management and modern merchandising capabilities so that brands can power their complex commerce experiences across multiple geographies, touchpoints, brands, and business models.
67

7-
This is an [Event Cloud Source](https://segment.com/docs/sources/#event-cloud-sources){:target="_blank"} which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations.
8+
This is an [Event Cloud Source](/docs/sources/#event-cloud-sources){:target="_blank"} which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations.
89

9-
This source is maintained by Elastic Path. For any issues with the source, contact the [Elastic Path's Support team](https://support.elasticpath.com/hc/en-us){:target="_blank"}.
10+
This source is maintained by Elastic Path. For any issues with the source, contact the [Elastic Path Support team](https://support.elasticpath.com/hc/en-us){:target="_blank"}.
1011

1112
## Getting started
1213

@@ -18,7 +19,8 @@ This source is maintained by Elastic Path. For any issues with the source, conta
1819
5. Copy the Write key from the Segment UI and log in to the Elastic Path Commerce Manager.
1920
6. Navigate to Integrations Hub > Select Segment integration > [configure integration](https://elasticpath.dev/docs/composer/integration-hub/customer-management/segment){:target="_blank"} where you need to use Segment key.
2021

21-
This integration is uses JSONata templates to provide flexibility to send your custom fields to Segment.
22+
This integration uses JSONata templates to provide flexibility to send your custom fields to Segment.
23+
2224
You can configure how you want to associate an Elastic Path event with Segment event for streaming data. For example, send the `Order Completed` event to Segment when the Elastic Path order event is `order.paid` or `order.authorized` or if order is fulfilled, for example, `order.fulfilled`.
2325

2426

@@ -30,15 +32,15 @@ The table below lists events that Elastic Path sends to Segment. These events ap
3032
| -------------------------------- | ---------------------------------------------------------------------- |
3133
| `Customer Created` | Creating identity in Segment. |
3234
| `Customer Updated` | Updating identity in Segment |
33-
| `Checkout Started` | When a user started the checkout process. For example, when a user creates an order. |
34-
| `Order Completed` | Tracks when a user completes their order. For example, when an order is paid or authorized. |
35-
| `Order Updated` | When an order is updated. For example, when the user updates the shipping address. |
36-
| `Order Cancelled` | When a user cancels an order. |
37-
| `Order Refunded` | When a user refunds an order. |
35+
| `Checkout Started` | When a user started the checkout process. For example, when a user creates an order. |
36+
| `Order Completed` | Tracks when a user completes their order. For example, when an order is paid or authorized. |
37+
| `Order Updated` | When an order is updated. For example, when the user updates the shipping address. |
38+
| `Order Cancelled` | When a user cancels an order. |
39+
| `Order Refunded` | When a user refunds an order. |
3840

3941
## Event properties
4042

41-
The tables below list the properties included in the events listed above.
43+
The property name tables below of the different events list the properties included in the events listed above.
4244

4345
### Identity events
4446

@@ -68,13 +70,13 @@ The following payload contains the properties for the following events:
6870

6971
| Property Name | Description |
7072
| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
71-
| `userId` | If the registered user places an order, then the value of the userId is the Customer ID. Otherwise, it will be the order ID. You can change this as per your requirement. |
73+
| `userId` | If the registered user places an order, then the value of the userId is the Customer ID. Otherwise, it will be the order ID. You can change this as per your requirement. |
7274
| `event` | The event name, for example, `Checkout Started`, `Order Completed`. |
7375
| `properties` | This holds information about the order. |
7476
| `properties.order_id` | The Elastic Path Order ID. |
7577
| `properties.value` | The revenue ($) with discounts and coupons added in. For better flexibility and total control over tracking, Elastic Path lets you decide how to calculate how coupons and discounts are applied. This is usually required for the `Checkout Started` event. |
7678
| `properties.total` | The revenue ($) with discounts and coupons added in. For better flexibility and total control over tracking, Elastic Path lets you decide how to calculate how coupons and discounts are applied. This is usually required for all the events apart from the `Checkout Started` event. |
77-
| `properties.revenue` | The revenue ($) associated with the transaction (excluding shipping and tax). This is usually required for all the events apart from the `Checkout Started` event. |
79+
| `properties.revenue` | The revenue ($) associated with the transaction (excluding shipping and tax). This is usually required for all the events apart from the `Checkout Started` event. |
7880
| `properties.tax` | The total tax associated with the transaction. |
7981
| `properties.discount` | The total discount associated with the transaction. |
8082
| `properties.shipping` | The shipping cost associated with the transaction. |
@@ -86,8 +88,8 @@ The following payload contains the properties for the following events:
8688
| `properties.products.$.price` | The product unit price. |
8789
| `properties.products.$.quantity` | The quantity of a product. |
8890

89-
Note: Elastic path is using properties of these events from the [eCommerce Spec](https://segment-docs.netlify.app/docs/connections/spec/ecommerce/v2){:target="_blank"} defined by the Segment doc. Add more properties as per this documentation based on your business requirement.
91+
Note: Elastic path uses properties of these events from the [eCommerce Spec](/docs/connections/spec/ecommerce/v2){:target="_blank"} defined by the Segment doc. Add more properties as per this documentation based on your business requirement.
9092

9193
## Add destinations
9294

93-
Now that you've configured your source, you can connect it with destinations. Log in to your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the Event Delivery tool, and refer to the Destination docs for each tool for troubleshooting. If there are any issues with how the events arrive to Segment, contact the [Elastic Path Support team](https://support.elasticpath.com/hc/en-us){:target="_blank"}.
95+
After you configure your source, you can connect it with destinations. Log in to your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the Event Delivery tool, and refer to the destination docs for each tool for troubleshooting. If there are any issues with how the events arrive to Segment, contact the [Elastic Path Support team](https://support.elasticpath.com/hc/en-us){:target="_blank"}.

0 commit comments

Comments
 (0)