Refund Source Data

Tracks refunds issued for orders, including transaction details and payout amounts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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 NameDescription
location_idIdentifier for the location where the refund occurred.
product_idIdentifier for the product associated with the refund.
brandBrand associated with the refund.
platformPlatform or ordering source where the refund was processed.
location_nameName of the location where the refund occurred.
order_dateDate when the order was placed.
order_date_timeTimestamp when the order was placed.
transaction_typeType of transaction (e.g., refund, order).
total_payoutTotal amount paid out for the refund.
subtotalSubtotal amount before taxes and fees.
store_typeType of store where the refund was processed (if applicable).
external_store_idIdentifier 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.

Query Params
location_ids
array of int32s
required
Defaults to 2438

External store identifier IDs should be separated by commas (e.g., 2438, 5689), with a maximum of 200 IDs

location_ids*
string
required
Defaults to 2024-10-16 00:00:00

Start Date time for the range of 24 hours

string
required
Defaults to 2024-10-17 00:00:00

End Date time for the range of 24 hours

Headers
string
required
Defaults to b7e9f1ca-62c9-4a44-9d2d-2185e03b0895

Brand token

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json