Enable ODP in Configured Commerce

  • Updated

To use Optimizely Data Platform (ODP) with Optimizely Configured Commerce, you must configure the following integration jobs for exporting products, warehouses, orders, customers, user profiles, and customer user profiles data to ODP.

Prequisites

Ensure you have followed all prerequisites. You must have validated whether or not your environment uses unique email addresses before integrating with ODP.

Enable ODP Integration

This must be completed as part of a manual provisioning request. Verify ODP tracking is enabled under Settings > Integration > ODP Integration. Contact Support if the integration is not enabled.

Custom order status mapping

If you have custom order statuses, you can configure which statuses should sync to ODP without any code changes.

  1. Go to Order Status Mapping in the Admin Console.
  2. Click Edit for the order status.
  3. Map the order statuses to an ODP Action Type of Purchase or Cancel. If a status does not correspond to either action type, you can leave it unmapped.

    Update ODP action type.png

    Typically, you should map statuses such as Submitted, Purchased, Order Placed, or any custom status that represents an order being successfully submitted (or that aligns with an ERP order placed status) to Purchase. Map any status representing a cancelled order to Cancel.

By default, Configured Commerce sends the following order statuses to ODP: Submitted, Punchout, and ReadyForPickup as Purchase, and CancellationRequested as Cancel. If needed, you can map additional order statuses to the appropriate ODP action types using the previous steps.

Real-time data

Once the ODP integration is enabled, any additions or updates to products, customers, users, and so on are sent in real time to ODP from the Configured Commerce backend through ODP REST APIs.

Historical data

Create the following integration jobs to send product, customer, user profile, customer user profile, warehouse, and order data to ODP.

  1. Export products to ODP – Create an integration job with ProductOdpExport as the Post Processor, configure any necessary notifications, and schedule and run the job once. Verify the job runs in Configured Commerce and that ODP imports the data successfully.

    Product ODP Export.png

  2. Export warehouses to ODP – Create an integration job with WarehouseOdpExport as the Post Processor, configure any necessary notifications, and schedule and run the job once. Verify the job runs in Configured Commerce and that ODP imports the data successfully.

    Warehouse ODP Export.png

  3. Export orders to ODP – Create an integration job with OrderOdpExport as the Post Processor, configure any necessary notifications, and schedule and run the job once. Verify the job runs in Configured Commerce and that ODP imports the data successfully.

    Order ODP Export.png

  4. Export customers to ODP – Create an integration job with CustomerOdpExport as the Post Processor, configure any necessary notifications, and schedule and run the job once. Verify the job runs in Configured Commerce and that ODP imports the data successfully.

    Customers to ODP.png

  5. Export user profiles to ODP – Create an integration job with UserProfileOdpExport as the Post Processor, configure any necessary notifications, and schedule and run the job once. Verify the job runs in Configured Commerce and that ODP imports the data successfully.

    User Profiles Export.png

  6. Export customer user profiles to ODP – Create an integration job with CustomerToUserMappingOdpExport as the Post Processor, configure any necessary notifications, and schedule and run the job once. Verify the job runs in Configured Commerce and that ODP imports the data successfully.

    Customer User Profiles Export.png

Recommended strategy for scheduling data exports

  • You should use scheduled exports to initialize and periodically validate full data consistency across systems.
  • Real-time updates help maintain continuous synchronization with minimal latency.
  • Combine both approaches for optimal reliability:
    • Real-time feeds handle incremental changes as they occur.
    • Scheduled exports serve as a safety net to catch any data gaps caused by communication or processing issues.

Important notes

Date range parameters for historical export jobs

Historical export jobs support optional parameters for controlling the date range of processed data:

  • LookBackDays
  • StartDate
  • EndDate

These parameters let administrators fine-tune which records are included in each export run. When no parameters are provided, all data is exported.

LookBackDays

  • All historical export jobs support the LookBackDays parameter, which restricts processing to entities modified within the specified number of days.
    LookBackDays.png
  • Setting LookBackDays = 1 is recommended for daily job schedules, ensuring complete coverage of data changes within the last 24 hours while maintaining optimal performance.
  • Data sourced from external systems is not updated in real time. To keep this data current, schedule daily exports with LookBackDays = 1, or refresh manually as needed.

StartDate and EndDate

In addition to LookBackDays, export jobs also support StartDate and EndDate parameters. These parameters accept specific date and time values and let administrators define an explicit date range for the export.

Use these parameters when you need precise control over the time window of data being sent to ODP, such as when backfilling historical data or exporting a specific period.

Send custom properties to ODP

See Send custom properties to ODP in the developer documentation to extend Configured Commerce using real-time transmission or batch integration jobs.

User Events

Enabling storefront events tracks storefront users and sends the following events in real time to ODP through the ODP JavaScript tag and from the Configured Commerce backend through ODP REST APIs.

ODP event type ODP action Sent from
product add_to_cart Storefront ODP JS Tag
product remove_from_cart Storefront ODP JS Tag
product detail Storefront ODP JS Tag
page_view category Storefront ODP JS Tag
page_view cart Storefront ODP JS Tag
page_view website Storefront ODP JS Tag
navigation search Storefront ODP JS Tag
navigation sort Storefront ODP JS Tag
navigation filter Storefront ODP JS Tag
navigation autocomplete Storefront ODP JS Tag
account update Storefront ODP JS Tag
order purchase Backend using ODP REST API
account register Backend using ODP REST API
account login Backend using ODP REST API
account logout Storefront ODP JS Tag
product add_to_wishlist Storefront ODP JS Tag
product remove_from_wishlist Storefront ODP JS Tag
pageview   Storefront ODP JS Tag
business change_business Storefront ODP JS Tag