Skip navigation
User Manual
Overview

Order Events

Placed an order

Within 1 minute of an order being created, the extension will:

  • Push the following data to Drip using the Order Activity REST API endpoint:

    • email = customer's email address

    • provider = magento

    • order_id = Magento's internal ID for this order

    • order_public_id = Magento's customer facing ID for this order

    • grand_total = total amount the customer agreed to pay, including taxes, shipping, and discounts

    • total_discounts = total discounts across all items in the order

    • total_taxes = total tax on the order

    • total_fees = any additional fees

    • total_shipping = total shipping charges on the order, if applicable

    • currency = the alphabetic ISO 4217 code for the currency of the order

    • items_count = the number of unique items in the order

    • magento_source = the source of the order, which will be one of:

      • Storefront

      • Admin

      • API

    • version = the Magento store and Drip extension versions

  • items = an array with the following included per item:

    • product_id = a unique identifier for the product as stored in Magento

    • sku = the product SKU

    • name = the product name

    • brand = the product’s brand, vendor, or manufacturer

    • categories = an array of categories (e.g. shores, vitamins, books, videos)

    • price = the price of a single product

    • quantity = the quantity of the item ordered

    • discount = the discount on the item, taking quantity into account. For example, a $2.66 discount per item would be $5.34 if that item was of quantity 2

    • taxes = the taxes on the items, taking quantity into account like “discount” above.

    • fees = any additional fees on the items, taking quantity into account like “discount” above.

    • shipping = the shipping cost on the items, taking quantity into account like “discount” above.

    • total = the line item total after quantity, discount, taxes, fees, and shipping.

    • product_url = the Magento store URL for the product

    • image_url = the product’s image URL, as stored and hosted on Magento

  • billing_address

    • label = the label describing the billing address

    • first_name = the first name on the billing address

    • last_name = the last name on the billing address

    • company = the company on the billing address

    • address_1 = the billing street address

    • address_2 = additional line of the billing street address

    • city = the billing address city

    • state = the billing address state

    • postal_code = the billing address postal code

    • country = the billing address country

    • phone = the phone number associated with the billing address

  • shipping_address

    • label = the label describing the shipping address

    • first_name = the first name on the shipping address

    • last_name = the last name on the shipping address

    • company = the company on the shipping address

    • address_1 = the shipping street address

    • address_2 = additional line of the shipping street address

    • city = the shipping address city

    • state = the shipping address state

    • postal_code = the shipping address postal code

    • country = the shipping address country

    • phone = the phone number associated with the shipping address


Updated an order

Within 1 minute of an order's state being set to something other than Complete, Refunded, or Canceled, the extension will:

  • Push the following data to Drip using the Order Activity REST API endpoint:

    • Everything in “Placed an Order” plus:

      • order_state: Magento's order state for the order

      • order_status: Magento's order status for the order

  • If the "grand_total" property is different from that in the “Placed an Order” event, the Drip person’s LTV will be updated accordingly.


Fulfilled an order

Within 1 minute of an order's status being set to "Order Shipped" or "Complete", the extension will:

  • Push the following data to Drip using the Order Activity REST API endpoint:

    • Everything in “Placed an Order” plus:

      • fulfillment_state = <"Partially_fulfilled" or "Fulfilled" depending on if all items on the order have been fulfilled.>

  • The Drip person’s LTV will be updated to match the new “grand_total”.

Refunded an order

Within 1 minute of an order having a credit memo applied against it, the extension will:

  • Push the following data to Drip using the Order Activity REST API endpoint:

    • Everything in “Placed an Order” plus:

      • refund_amount = the amount refunded against the order

  • The refund_amount will be subtracted from the Drip person’s LTV.

Canceled an order

Within 1 minute of an order's status being set to "Cancelled", the extension will:


  • Push the following data to Drip using the Order Activity REST API endpoint:

    • order_id = Magento's internal ID for this order

    • canceled_at = the timestamp of order cancellation in ISO-8601 format

  • The total amount of the order will be subtracted from the Drip person’s LTV.

x A browser window showing the Drip Swag Shop

Wanna see Drip from a fresh angle?

Craving a more hands-on experience? Take 2 minutes and see what your shoppers see when you use Drip with this interactive experience.

Start my experience