Eventos E-commerce

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.

POST https://api.rd.services/platform/events

Request body parameters

Field	Type	Required	Description
event_type	String	true	The event type that diferentiates the event. For the placed order event it should be sent as "ORDER_PLACED".
event_family	String	true	The family of the event for processing purposes. It currently accepts only "CDP" as valid option.
name	String	false	Name of the contact.
email	String	true	Email of the contact.
cf_order_id	String	true	Order identifier
cf_order_total_items	Integer	true	Total number of itens from the order.
cf_order_status	String	true	Status of the order to when the event was triggered
cf_order_payment_method	String	true	Method of payment. Available options: "Credit Card", "Debit Card", "Invoice", "Others"
cf_order_payment_amount	Float	true	Total value of the order
legal_bases	Array of Objects	false	Legal 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

Field	Type	Valid Params
category	String	communications
type	String	pre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
status	String	granted 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.

POST https://api.rd.services/platform/events

Request body parameters

Field	Type	Required	Description
event_type	String	true	The event type that diferentiates the event. For the placed order item event it should be sent as "ORDER_PLACED_ITEM".
event_family	String	true	The family of the event for processing purposes. It currently accepts only "CDP" as valid option.
name	String	false	Name of the contact.
email	String	true	Email of the contact.
cf_order_id	String	true	Order identifier
cf_order_product_id	String	true	Product Identifier
cf_order_product_sku	String	true	Product SKU
legal_bases	Array of Objects	false	Legal 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

Field	Type	Valid Params
category	String	communications
type	String	pre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
status	String	granted 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.

POST https://api.rd.services/platform/events

Request body parameters

Field	Type	Required	Description
event_type	String	true	The event type that diferentiates the event. For the abandoned cart event it should be sent as "CART_ABANDONED".
event_family	String	true	The family of the event for processing purposes. It currently accepts only "CDP" as valid option.
name	String	false	Name of the contact.
email	String	true	Email of the contact.
cf_cart_id	String	true	Cart identifier
cf_cart_total_items	Integer	true	Total number of itens from the cart.
cf_cart_status	String	true	Status of the cart to when the event was triggered
legal_bases	Array of Objects	false	Legal 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

Field	Type	Valid Params
category	String	communications
type	String	pre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
status	String	granted 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.

POST https://api.rd.services/platform/events

Request body parameters

Field	Type	Required	Description
event_type	String	true	The event type that diferentiates the event. For the abandoned cart item event it should be sent as "CART_ABANDONED_ITEM".
event_family	String	true	The family of the event for processing purposes. It currently accepts only "CDP" as valid option.
name	String	false	Name of the contact.
email	String	true	Email of the contact.
cf_cart_id	String	true	Cart identifier
cf_cart_product_id	String	true	Identifier of the product that was left on the cart.
cf_cart_product_sku	String	true	SKU of the product that was left on the cart
legal_bases	Array of Objects	false	Legal 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

Field	Type	Valid Params
category	String	communications
type	String	pre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
status	String	granted or declined