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 attributesentity_id, customer_id, email, app_id, organization_id, and analytics.
  • Customer predictions — prediction models associated with the customer (via include=customer_predictions).
  • Validated predictions — a filtered subset of predictions where is_result_prediction is true.

Inputs

NameTypeDescription
Customer IDStringThe ID of the customer (e.g. Shopify customer ID)
App IDStringShopify store URL without https (e.g. the-shopify-store.myshopify.com). Provided by Yofi.
Secret KeySensitiveStringSecret key provided by Yofi for JWT signing (HS256)
Partner IDStringPlatform identifier within Yofi. Defaults to shopify.

Outputs

NameTypeDescription
SuccessBooleanWhether the customer was successfully retrieved
Customer DataObjectJSON:API response (data, etc.) excluding included. EcommerceCustomer attributes: entity_id, customer_id, email, app_id, organization_id, analytics
Customer PredictionsObjectAPI included payload: customer predictions when requested via include=customer_predictions
Customer Predictions ValidatedObjectCustomer predictions filtered where is_result_prediction is true
ErrorStringError message when success is false