Skip to main content
The Refunds Data Model simplifies the handling and retrieval of refunds-related information across various ecommerce platforms. The model provides a unified representation of refunds data, enabling you to easily access and manage refunds data from different platforms.
  • Unified Refunds properties: The model provides a unified representation of refunds properties across different platforms, enabling you to easily access and manage refunds data from different platforms.
  • Comprehensive refunds information: The model provides a comprehensive representation of refunds data, including all the properties and relationships that you can retrieve for a refund.

​
Attributes

​
Refund Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the refund
rootfi_created_atstringThe ISO 8601 timestamp at which the record was created in RootFi
rootfi_updated_atstringThe ISO 8601 timestamp at which the record was last updated in RootFi
rootfi_company_idintegerThe RootFi company ID associated with the refund
platform_idstringThe Platform’s ID for the refund
platform_unique_idstringThe platform’s unique identifier for the refund
parent_data_modelstringThe parent data model type (e.g., ECOMMERCE_ORDERS)
parent_data_model_idstringThe ID of the parent data model in the ecommerce platform
currency_idstringThe currency ID of the refund
created_atstringThe date and time the refund was created
updated_atstringThe date and time the refund was last updated
descriptionstringThe description of the refund
sub_totalnumberThe subtotal of items, fees etc.
sub_total_tax_amountnumberThe tax on subtotal of items, fees etc.
shipping_sub_totalnumberThe shipping subtotal
shipping_tax_amountnumberThe tax on shipping subtotal
total_amountnumberThe total amount including everything like shipping, taxes etc.
line_itemsLine Item[]The line items of the refund
shipping_line_itemsShipping Line Item[]The shipping line items of the refund

​
Line Item Attributes

PropertyTypeDescription
platform_idstringThe Platform’s ID for the line item
item_idstringThe ID of the item in the ecommerce platform
tax_idstringThe ID of the tax in the ecommerce platform
line_item_type_idstringThe ID of the line item type in the ecommerce platform
line_item_typeenumThe line item type (e.g., ECOMMERCE_ORDERS, ECOMMERCE_REFUNDS)
descriptionstringThe description of the line item
unit_amountnumberThe unit amount of the line item
quantitynumberThe quantity of the line item
total_discountnumberThe total discount of the line item
tax_amountnumberThe tax amount of the line item
sub_totalnumberThe subtotal of the line item
total_amountnumberThe total amount of the line item

​
Shipping Line Item Attributes

PropertyTypeDescription
platform_idstringThe Platform’s ID for the shipping line item
parent_data_modelstringThe parent data model type (e.g., ECOMMERCE_ORDERS, ECOMMERCE_REFUNDS)
parent_data_model_idstringThe ID of the parent data model in the ecommerce platform
titlestringThe title of the shipping line item
descriptionstringThe description of the shipping line item
sub_totalnumberThe subtotal of the shipping line item
tax_amountnumberThe tax amount on the shipping subtotal
total_amountnumberThe total amount including shipping and taxes

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the refund
parent_data_modelstringThe parent data model type (e.g., ECOMMERCE_ORDERS)
parent_data_model_idstringThe ID of the parent data model in the ecommerce platform
currency_idstringThe currency ID of the refund
created_atstringThe date and time the refund was created
updated_atstringThe date and time the refund was last updated
descriptionstringThe description of the refund
sub_totalnumberThe subtotal of items, fees etc.
sub_total_tax_amountnumberThe tax on subtotal of items, fees etc.
shipping_sub_totalnumberThe shipping subtotal
shipping_tax_amountnumberThe tax on shipping subtotal
total_amountnumberThe total amount including everything like shipping, taxes etc.
line_itemsobject[]The line items of the refund
shipping_line_itemsobject[]The shipping line items of the refund
{
  "rootfi_id": 157,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "ref_123456",
  "platform_unique_id": "REF-2024-001",
  "parent_data_model": "ECOMMERCE_ORDERS",
  "parent_data_model_id": "ord_123456",
  "currency_id": "USD",
  "created_at": "2024-01-22T05:07:31.465Z",
  "updated_at": "2024-01-22T05:07:31.000Z",
  "description": "Refund for Order #ORD-2024-001",
  "sub_total": 89.99,
  "sub_total_tax_amount": 7.20,
  "shipping_sub_total": 5.99,
  "shipping_tax_amount": 0.48,
  "total_amount": 103.66,
  "line_items": [
    {
      "platform_id": "li_123456",
      "item_id": "prod_789",
      "tax_id": "tax_001",
      "line_item_type_id": "ref_123456",
      "line_item_type": "ECOMMERCE_REFUNDS",
      "description": "Wireless Headphones - Black",
      "unit_amount": 99.99,
      "quantity": 1,
      "total_discount": 10.00,
      "tax_amount": 7.20,
      "sub_total": 89.99,
      "total_amount": 97.19
    }
  ],
  "shipping_line_items": [
    {
      "platform_id": "sli_123456",
      "parent_data_model": "ECOMMERCE_REFUNDS",
      "parent_data_model_id": "ref_123456",
      "title": "Standard Shipping",
      "description": "Standard shipping via USPS",
      "sub_total": 5.99,
      "tax_amount": 0.48,
      "total_amount": 6.47
    }
  ]
}