Tracking orders

Recipe-based analytics offer detailed insight into product configurations created by users. However, this data alone does not provide a complete view of conversion events. In order to track conversions—i.e., when a configuration results in a completed purchase—additional data from the eCommerce platform is required.

Since the order number is not available at the time a recipe is created, it is the responsibility of the eCommerce platform to establish an association between the order number and the corresponding recipes used on each line item. This linkage enables downstream systems to accurately attribute orders to specific configurations and supports comprehensive reporting and analysis.

Creating order-to-recipe associations using API

If the Order Management System (OMS) or eCommerce platform supports direct invocation of REST APIs, Drive Commerce recommends using the API integration method. This approach enables tighter control over the structure, scope, and flow of data exchanged between systems, and reduces the likelihood of transmitting unnecessary or sensitive information.

In order to create an association, the OMS should trigger a REST API call using a POST method.

Target URL: https://api.customizer.drivecommerce.com/api/v2/recipe/order

Authentication

Provide an API key with Order Tracking permissions using apikey= query string parameter or Authentication: Bearer HTTP header

Payload

To establish an association between orders and recipes, the client system shall issue a POST request containing a JSON payload. The payload must include an array of order-to-recipe association descriptors, each representing the linkage between an order and one or more recipes used in its line items.

For example:

[
    {
        "recipeId": "DRIVE-001",
        "orderNumber": "1001",
        "orderId": "1111111111111",
        "itemId": "2222222222222",
        "itemQuantity": 2
    },
    {
        "recipeId": "DRIVE-002",
        "orderNumber": "1001",
        "orderId": "1111111111111",
        "itemId": "3333333333333",
        "itemQuantity": 1
    }
]

Each item shall contain:

Creating order-to-recipe association using native integrations

As an alternative to direct API usage, Drive Commerce offers a number of prebuilt eCommerce platform integrations. Depending on the target platform and its data handling mechanisms, these integrations may transmit certain sensitive data as part of the order payload.

Care should be taken to assess the data shared during integration, especially where personally identifiable information (PII) may be included. The handling of such data is subject to the terms outlined in the Drive Commerce Data Processing Agreement (DPA).

PII handling of order data

The Customizer platform does not store any personally identifiable information (PII) typically associated with order data, such as:

• Customer names, addresses, or email addresses

• Payment details or billing information

Only non-personal metadata is utilized to establish associations between orders and recipes. This includes:

• Order number

• Order ID

• Line item ID

• Quantity values

While the Customizer platform does not store personally identifiable information (PII), it includes safeguards to discard or anonymize such data when necessary. However, integration with external order systems depends on the capabilities of the third-party platforms involved.

In some cases, the integration can be configured to retrieve only the necessary non-personal order data. In other scenarios, the external platform may submit the full order payload, which may include PII. This introduces the possibility of PII crossing the customer–Drive Commerce boundary.

The handling and processing of such information is governed by the Drive Commerce Data Processing Agreement (DPA).