Refunds

List all refunds

Changed on

Returns a list all refund objects.

get/refunds/

Request

  • Base URL
    https://api.goshippo.com
  • URL
    https://api.goshippo.com/refunds/
  • Auth
    API key in header Authorization

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

SHIPPO-ACCOUNT-IDstring

Optional. The object ID of a Managed Shippo Account. Platform accounts set this to make the request on behalf of one of their managed accounts. See the Platform accounts guide.

Response

Paginated list of refunds

nextstring
previousstring

Example response

{
  "next": "baseurl?page=3&results=10",
  "previous": "baseurl?page=1&results=10",
  "results": [
    {
      "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
      "object_owner": "shippotle@shippo.com",
      "status": "SUCCESS",
      "transaction": "915d94940ea54c3a80cbfa328722f5a1"
    }
  ]
}

Changes