Klaviyo integration: Events & Payloads

There are 12 events that PostCo can send over to Klaviyo. These are: 

1. Return confirmed: When a customer successfully submits a return request.

2. Return reviewed: When customer’s return request has been approved and return label / return address is sent.

3. Return received: When customer’s return shipment has been received at the warehouse.

4. Return completed: When customer’s return request has been completed.

5. Return rejected: When customer’s return request has been rejected.

6. Store credit (discount code): When a store credit via discount has been issued to the customer.

7. Return label payment: When customer’s return request has been approved and payment is required for the return label.

8. Exchange upsell payment: When payment is required for the exchange upsell.

9. Return label and exchange upsell payment failure: When customer’s payment method could not be charged successfully for the return label and exchange upsell.

10. Instant exchange shipback reminder: When a reminder is sent before the shipback window deadline for instant exchange.

11. Instant exchange payment request: When payment is required for the return shipments if they are not shipped back within the shipback window or if the return items have been rejected for instant exchange.

12. Instant exchange deposit refunded: When the deposit has been refunded for instant exchange.

By default, each event contains the following fields in its payload:

• shop_logo_url

• summary_url

• order_name

• exchanges 

  • return_item_image_url

  • return_item_name

  • sku

  • show_sku (boolean)

  • paid_amount

  • exchange_item_name

  • rejected (boolean)

  • reject_reason

  • status

  • exchange_order_created (boolean)

  • keep_item (boolean)

• refunds

  • return_item_image_url

  • return_item_name

  • sku

  • show_sku (boolean)

  • paid_amount

  • refund_method_name

  • rejected (boolean)

  • reject_reason

  • status

  • refund_issued (boolean)

  • store_credit_created (boolean)

  • keep_item (boolean)

Note: all fields are strings (or an array of strings) unless otherwise noted.

The following events have additional fields in their payload.

Includes the following additional fields:

• courier_name

• customer_borne_pickup (boolean)

• have_keep_items (boolean)

• on_demand_pickup (boolean)

• packing_instruction

• pickup_datetime

• pickup_address

• require_shipment_label (boolean)

• shipment_label_link

• tracking_number

• tracking_url

• customs_form_url

• qr_code_url

• shipping_method

  • name

• warehouse_address

  • full_address

• return_order

  • all_items_keep (boolean)

  • exchange_order_and_store_credit_created_on_shipment_in_transit (boolean)

  • exchange_order_and_store_credit_created_on_reviewed (boolean)

  • exchange_order_created_on_shipment_in_transit (boolean)

  • exchange_order_created_on_reviewed (boolean)

  • store_credit_created_on_shipment_in_transit (boolean)

  • store_credit_created_on_reviewed (boolean)

Includes the following additional fields:

• return_order

  • all_items_keep (boolean)

  • exchange_order_and_store_credit_created_on_received (boolean)

  • exchange_order_created_on_received (boolean)

  • store_credit_created_on_received (boolean)

  • store_credit_created (boolean)

  • exchange_order_created (boolean)

Includes the following additional fields:

• receipt_url

• amount_pending_payment

• amount_refunded

Includes the following additional fields:

• discount_code

• discount_code_expired_on

• store_credit_amount

• return_order_name

Includes the following additional fields:

• courier_name

• call_to_action_url

• requires_shipment_payment (boolean)

• requires_scheduling (boolean)

• drop_off (boolean)
  

Includes the following additional fields:

• payment_link

• return_order_name

• courier_name

• invoices_total_amount

Includes the following additional fields:

• payment_link

• payment_error

Includes the following additional fields:

• return_order_name

• remaining_number_of_days (number)

• return_date

• auth_charge_date

Includes the following additional fields:

• payment_link

• payment_error

• charge_reason