Skip to content

Commit 310c877

Browse files
author
Prashant Singh
committed
Add new Elastic Path source docs
1 parent 751112e commit 310c877

File tree

1 file changed

+89
-0
lines changed
  • src/connections/sources/catalog/cloud-apps/elastic-path

1 file changed

+89
-0
lines changed

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

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
title: Elastic Path Source
3+
---
4+
5+
[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.
6+
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+
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+
11+
## Getting started
12+
13+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank"} click **Add Source**.
14+
2. Search for **Elastic Path** in the Sources Catalog, select **Elastic Path**, and click **Add Source**.
15+
3. On the next screen, give the Source a name configure any other settings.
16+
- The name identifies this source within your workspace, and typically reflects the name of the application. The name can be anything, but Segment recommends that you use something that reflects the source itself and distinguishes amongst your environments (for example, `SourceName_Prod`, `SourceName_Staging`, or `SourceName_Dev`).
17+
4. Click **Add Source** to save your settings.
18+
5. Copy the Write key from the Segment UI and log in to Elastic Path Commerce Manager - 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
19+
6. This integration is using JSONata templates to provide flexibility to send your custom fields as well to Segment.
20+
7. In this integration, you can configure that how you want to associate Elastic Path event with Segment event for streaming data e.g. send `Order Completed` event to Segment when Elastic Path order event is `order.paid` or `order.authorized` or if order is fulfilled i.e. `order.fulfilled`.
21+
22+
23+
## Events
24+
25+
The table below lists events that Elastic Path sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations.
26+
27+
| Event Name | Description |
28+
| -------------------------------- | ---------------------------------------------------------------------- |
29+
| `Customer Created` | Creating identity in Segment. |
30+
| `Customer Updated` | Updating identity in Segment |
31+
| `Checkout Started` | Checkout started event e.g. when order is created |
32+
| `Order Completed` | Order completed event e.g. when order is paid or authorized |
33+
| `Order Updated` | Order updated event e.g. when shipping address is updated |
34+
| `Order Cancelled` | Order cancelled event |
35+
| `Order Refunded` | Order refunded event |
36+
37+
## Event properties
38+
39+
The table below list the properties included in the events listed above.
40+
41+
### Identity events
42+
43+
The following payload contains the properties for the following events:
44+
45+
- `Customer Created`
46+
- `Customer Updated`
47+
48+
| Property Name | Description |
49+
| ----------------------- | ------------------------------------------------------------------------------------------------------------------ |
50+
| `userId` | Customer ID of Elastic Path Composable Commerce |
51+
| `traits` | Free-form dictionary of traits of the user, like email or |
52+
| `traits.name` | Customer name |
53+
| `traits.email` | Customer email |
54+
55+
**Note**: You can add any custom fields as well as part of the traits e.g. age, gender, title, phone etc.
56+
57+
### Order events
58+
59+
The following payload contains the properties for the following events:
60+
61+
- `Checkout Started`
62+
- `Order Completed`
63+
- `Order Updated`
64+
- `Order Cancelled`
65+
- `Order Refunded`
66+
67+
| Property Name | Description |
68+
| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
69+
| `userId` | If registered user place order then the value of userId will be the Customer ID otherwise it will be order ID. You can change this as per your requirement. |
70+
| `event` | Event name e.g. `Checkout Started`, `Order Completed` etc. |
71+
| `properties` | This will hold information about the order |
72+
| `properties.order_id` | Elastic Path Order ID |
73+
| `properties.value` | Revenue ($) with discounts and coupons added in. For better flexibility and total control over tracking, we let you decide how to calculate how coupons and discounts are applied |
74+
| `properties.tax` | Total tax associated with the transaction |
75+
| `properties.discount` | Total discount associated with the transaction |
76+
| `properties.shipping` | Shipping cost associated with the transaction |
77+
| `properties.currency` | Currency code associated with the transaction e.g. GBP, USD etc. |
78+
| `properties.products` | List of products in the order |
79+
| `properties.products.$.product_id` | Product ID |
80+
| `properties.products.$.name` | Product Name |
81+
| `properties.products.$.sku` | Product SKU |
82+
| `properties.products.$.price` | Product Unit Price |
83+
| `properties.products.$.quantity` | Quantity of a product |
84+
85+
Note: We are using properties of these events from [eCommerce Spec](https://segment-docs.netlify.app/docs/connections/spec/ecommerce/v2){:target="_blank"} defined by Segment doc. Add more properties as per this documentation based on your business requirement.
86+
87+
## Add destinations
88+
89+
Now that your Source is configured, you can connect it with Destinations. Log into 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 are arriving to Segment, contact the [Elastic Path's Support team](https://support.elasticpath.com/hc/en-us){:target="_blank"}.

0 commit comments

Comments
 (0)