Os eventos de e-commerce são responsáveis por descrever o comportamento de um contato no processo de compra de produtos em um e-commerce. Por meio desses eventos é possível indicar quando um Contato fecha um pedido ou até mesmo abandona um carrinho, informando quais os produtos envolvidos no processo.


Evento de Fechamento de Pedido

O RD Station Marketing considera sempre o valor do atributo event_type ORDER_PLACED como identificador deste evento customizado. Esse evento é registrado sempre que ocorre o fechamento de pedido em uma plataforma de e-commerce.

Request body parameters
FieldTypeRequiredDescription
event_typeStringtrueThe event type that diferentiates the event. For the placed order event it should be sent as "ORDER_PLACED".
event_familyStringtrueThe family of the event for processing purposes. It currently accepts only "CDP" as valid option.
nameStringfalseName of the contact.
emailStringtrueEmail of the contact.
cf_order_idStringtrueOrder identifier
cf_order_total_itemsIntegertrueTotal number of itens from the order.
cf_order_statusStringtrueStatus of the order to when the event was triggered
cf_order_payment_methodStringtrueMethod of payment. Available options: "Credit Card", "Debit Card", "Invoice", "Others"
cf_order_payment_amountFloattrueTotal value of the order
legal_basesArray of ObjectsfalseLegal Bases of the contact.
Request body example
{
  "event_type": "ORDER_PLACED",
  "event_family":"CDP",
  "payload": {
    "name": "Contact's Name",
    "email": "[email protected]",
    "cf_order_id": "order identifier",
    "cf_order_total_items": 2,
    "cf_order_status": "pending_payment",
    "cf_order_payment_method": "Credit Card",
    "cf_order_payment_amount": 40.20,
    "legal_bases": [
      {
        "category": "communications",
        "type":"consent",
        "status":"granted"
      }
    ]
  }
}
Legal Bases
FieldTypeValid Params
categoryStringcommunications
typeStringpre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
statusStringgranted or declined

Evento de Fechamento de Pedido com um Item específico

O RD Station Marketing considera sempre o valor do atributo event_type ORDER_PLACED_ITEM como identificador do evento customizado. Esse evento é registrado sempre que ocorre o fechamento de pedido com um item específico em uma plataforma de e-commerce.

Request body parameters
FieldTypeRequiredDescription
event_typeStringtrueThe event type that diferentiates the event. For the placed order item event it should be sent as "ORDER_PLACED_ITEM".
event_familyStringtrueThe family of the event for processing purposes. It currently accepts only "CDP" as valid option.
nameStringfalseName of the contact.
emailStringtrueEmail of the contact.
cf_order_idStringtrueOrder identifier
cf_order_product_idStringtrueProduct Identifier
cf_order_product_skuStringtrueProduct SKU
legal_basesArray of ObjectsfalseLegal Bases of the contact.
Request body example
{
  "event_type": "ORDER_PLACED_ITEM",
  "event_family":"CDP",
  "payload": {
    "name": "Contact's Name",
    "email": "[email protected]",
    "cf_order_id": "Order Identifier",
    "cf_order_product_id": "Product 1",
    "cf_order_product_sku": "SKU 1",
    "legal_bases": [
      {
        "category": "communications",
        "type": "consent",
        "status": "granted"
      }
    ]
  }
}
Legal Bases
FieldTypeValid Params
categoryStringcommunications
typeStringpre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
statusStringgranted or declined

Evento de Abandono de Carrinho

O RD Station Marketing considera sempre o valor do atributo event_type CART_ABANDONED como identificador do evento customizado. Esse evento é registrado sempre que ocorre o abandono de carrinho em uma plataforma de e-commerce.

Request body parameters
FieldTypeRequiredDescription
event_typeStringtrueThe event type that diferentiates the event. For the abandoned cart event it should be sent as "CART_ABANDONED".
event_familyStringtrueThe family of the event for processing purposes. It currently accepts only "CDP" as valid option.
nameStringfalseName of the contact.
emailStringtrueEmail of the contact.
cf_cart_idStringtrueCart identifier
cf_cart_total_itemsIntegertrueTotal number of itens from the cart.
cf_cart_statusStringtrueStatus of the cart to when the event was triggered
legal_basesArray of ObjectsfalseLegal Bases of the contact.
Request body example
{
  "event_type": "CART_ABANDONED",
  "event_family":"CDP",
  "payload": {
    "name": "Contact's Name",
    "email": "[email protected]",
    "cf_cart_id": "Cart identifier",
    "cf_cart_total_items": 2,
    "cf_cart_status": "in_progress",
    "legal_bases": [
      {
        "category": "communications",
        "type": "consent",
        "status": "granted"
      }
    ]
  }
}
Legal Bases
FieldTypeValid Params
categoryStringcommunications
typeStringpre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
statusStringgranted or declined

Evento de Abandono de um Item do Carrinho

O RD Station Marketing considera sempre o valor do atributo event_type CART_ABANDONED_ITEM como identificador do evento customizado. Esse evento é registrado sempre que ocorre o abandono de carrinho com um item específico em uma plataforma de e-commerce.

Request body parameters
FieldTypeRequiredDescription
event_typeStringtrueThe event type that diferentiates the event. For the abandoned cart item event it should be sent as "CART_ABANDONED_ITEM".
event_familyStringtrueThe family of the event for processing purposes. It currently accepts only "CDP" as valid option.
nameStringfalseName of the contact.
emailStringtrueEmail of the contact.
cf_cart_idStringtrueCart identifier
cf_cart_product_idStringtrueIdentifier of the product that was left on the cart.
cf_cart_product_skuStringtrueSKU of the product that was left on the cart
legal_basesArray of ObjectsfalseLegal Bases of the contact.
Request body example
{
  "event_type": "CART_ABANDONED_ITEM",
  "event_family":"CDP",
  "payload": {
    "name": "Contact's Name",
    "email": "[email protected]",
    "cf_cart_id": "Cart identifier",
    "cf_cart_product_id": "Product identifier",
    "cf_cart_product_sku": "Product SKU",
    "legal_bases": [
      {
        "category": "communications",
        "type": "consent",
        "status": "granted"
      }
    ]
  }
Legal Bases
FieldTypeValid Params
categoryStringcommunications
typeStringpre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
statusStringgranted or declined