Model: Event

1 min

Model Parameters

Event
- typestringrequired
  Example
  order
  Description
  the event type
  Default
  order
- actionstringrequired
  Example
  purchase
  Description
  the event action associated with the type. Acceptable actions include: purchase, return, refund, and cancel
- identifiersmap<string, string>required
  Description
  any known identifiers associated with the customer that performed the event
- datamap<string, string>
  Description
  the data with the order and any additional fields
  - tsnumber
    Description
    specify the time of the order action
  - orderOrder
    - order_idstringrequired
      Description
      the unique identifier related to this order
    - totalnumber
      Description
      total should include the final amount charged to the customer after all goods, discounts, tax, and shipping are calculated. See below for more information
    - subtotalnumber
      Description
      subtotal may be taken either before or after discounting, but generally should be before shipping or tax
    - taxnumber
    - shippingnumber
    - itemsLineItem[]
      - product_idstringrequired
        Description
        the unique identifier for the order line item
      - pricenumber
        Description
        the price for an order line item
      - quantitynumber
        Description
        the number of items purchased
      - discountnumber
        Description
        the discount (if any) for the given line item
      - subtotalnumber
        Description
        the calculated subtotal for the given product and quantity, typically calculated after any discounts