Refund Source Data API

The Refund Source Data API provides detailed information about refunds issued for orders, including transaction details and payout amounts. This API is invaluable for tracking refunds, analyzing discrepancies, and improving financial reconciliation processes.

Example Response

After a successful call, the API will return a response similar to the below structure.

[
    {
        "location_id": 233271,
        "product_id": 7,
        "brand": "IACM",
        "platform": "Ordering Platform",
        "location_name": "Location Name",
        "order_date": "2024-10-16",
        "order_date_time": "2024-10-16T22:38:27.000Z",
        "transaction_type": "Order",
        "total_payout": "18.38",
        "subtotal": "22.97",
        "store_type": "",
        "external_store_id": null
    }
  ]

Field Descriptions

Field Name	Description
`location_id`	Identifier for the location where the refund occurred.
`product_id`	Identifier for the product associated with the refund.
`brand`	Brand associated with the refund.
`platform`	Platform or ordering source where the refund was processed.
`location_name`	Name of the location where the refund occurred.
`order_date`	Date when the order was placed.
`order_date_time`	Timestamp when the order was placed.
`transaction_type`	Type of transaction (e.g., refund, order).
`total_payout`	Total amount paid out for the refund.
`subtotal`	Subtotal amount before taxes and fees.
`store_type`	Type of store where the refund was processed (if applicable).
`external_store_id`	Identifier for the external store, if applicable.

This API assists in comprehensive tracking and analysis of refund activities, enabling more effective financial management and operational decision-making.