v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

List Refunds

get/sites/multiscreen/{site_name}/ecommerce/orders/{order_id}/refunds

Path parameters

site_namestring required

The unique identifier for the target Site.

order_idstring required

The unique identifier for the Order.

Query parameters

offsetinteger

Zero-based offset for elements (0..N)

limitinteger

The size of the page to be returned

sortstring

Property used to sort orders

directionstring

The sort direction, either "asc" or "desc"

Response

200

limitinteger
offsetinteger
total_responsesinteger

Example response

{
  "results": [
    {
      "created": "2024-03-15T17:58:48.331Z",
      "currency": "string",
      "id": "string",
      "items": [
        {
          "id": "string",
          "taxes": [
            {
              "id": "string",
              "name": "string",
              "provider": "BUILT_IN"
            }
          ]
        }
      ],
      "order_id": "string",
      "reason": "string",
      "tax_provider": {
        "avalara_reference_id": "string",
        "provider": "BUILT_IN"
      },
      "taxes": [
        {
          "id": "string",
          "name": "string",
          "provider": "BUILT_IN"
        }
      ],
      "transaction_id": "string"
    }
  ]
}