Yofi Get Customer Data
Retrieves customer details from the Yofi Partner Data API (GET /ecommerce/customers/{customer_id}/). The action authenticates via JWT (HS256) using the App ID and Secret Key provided by Yofi, then returns the customer profile along with prediction data.
Returned data includes:
- Customer attributes —
entity_id,customer_id,email,app_id,organization_id, andanalytics. - Customer predictions — prediction models associated with the customer (via
include=customer_predictions). - Validated predictions — a filtered subset of predictions where
is_result_predictionistrue.
Inputs
| Name | Type | Description |
|---|---|---|
| Customer ID | String | The ID of the customer (e.g. Shopify customer ID) |
| App ID | String | Shopify store URL without https (e.g. the-shopify-store.myshopify.com). Provided by Yofi. |
| Secret Key | SensitiveString | Secret key provided by Yofi for JWT signing (HS256) |
| Partner ID | String | Platform identifier within Yofi. Defaults to shopify. |
Outputs
| Name | Type | Description |
|---|---|---|
| Success | Boolean | Whether the customer was successfully retrieved |
| Customer Data | Object | JSON:API response (data, etc.) excluding included. EcommerceCustomer attributes: entity_id, customer_id, email, app_id, organization_id, analytics |
| Customer Predictions | Object | API included payload: customer predictions when requested via include=customer_predictions |
| Customer Predictions Validated | Object | Customer predictions filtered where is_result_prediction is true |
| Error | String | Error message when success is false |
Updated about 2 hours ago