GET
/
api
/
v2
/
platform
/
store_credits
Return a list of Store Credits
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/store_credits \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "2",
      "type": "store_credit",
      "attributes": {
        "amount": "150.0",
        "amount_used": "0.0",
        "memo": null,
        "deleted_at": null,
        "currency": "USD",
        "amount_authorized": "0.0",
        "originator_type": null,
        "created_at": "2022-11-08T19:35:38.714Z",
        "updated_at": "2022-11-08T19:35:38.714Z",
        "public_metadata": {},
        "private_metadata": {},
        "display_amount": "$150.00",
        "display_amount_used": "$0.00"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "107",
            "type": "user"
          }
        },
        "created_by": {
          "data": {
            "id": "108",
            "type": "user"
          }
        },
        "store_credit_category": {
          "data": {
            "id": "14",
            "type": "store_credit_category"
          }
        },
        "store_credit_type": {
          "data": {
            "id": "14",
            "type": "store_credit_type"
          }
        },
        "store_credit_events": {
          "data": [
            {
              "id": "3",
              "type": "store_credit_event"
            }
          ]
        }
      }
    },
    {
      "id": "3",
      "type": "store_credit",
      "attributes": {
        "amount": "150.0",
        "amount_used": "0.0",
        "memo": null,
        "deleted_at": null,
        "currency": "USD",
        "amount_authorized": "0.0",
        "originator_type": null,
        "created_at": "2022-11-08T19:35:38.722Z",
        "updated_at": "2022-11-08T19:35:38.722Z",
        "public_metadata": {},
        "private_metadata": {},
        "display_amount": "$150.00",
        "display_amount_used": "$0.00"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "107",
            "type": "user"
          }
        },
        "created_by": {
          "data": {
            "id": "109",
            "type": "user"
          }
        },
        "store_credit_category": {
          "data": {
            "id": "15",
            "type": "store_credit_category"
          }
        },
        "store_credit_type": {
          "data": {
            "id": "15",
            "type": "store_credit_type"
          }
        },
        "store_credit_events": {
          "data": [
            {
              "id": "4",
              "type": "store_credit_event"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/store_credits?page=1&per_page=&include=&filter[user_id_eq]=&filter[created_by_id_eq]=&filter[amount_gteq]=&filter[currency_eq]=",
    "next": "http://www.example.com/api/v2/platform/store_credits?filter%5Bamount_gteq%5D=&filter%5Bcreated_by_id_eq%5D=&filter%5Bcurrency_eq%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/store_credits?filter%5Bamount_gteq%5D=&filter%5Bcreated_by_id_eq%5D=&filter%5Bcurrency_eq%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/store_credits?filter%5Bamount_gteq%5D=&filter%5Bcreated_by_id_eq%5D=&filter%5Bcurrency_eq%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/store_credits?filter%5Bamount_gteq%5D=&filter%5Bcreated_by_id_eq%5D=&filter%5Bcurrency_eq%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
​
per_page
integer
​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

​
filter[user_id_eq]
string
​
filter[created_by_id_eq]
string
​
filter[amount_gteq]
string
​
filter[currency_eq]
string

Response

200
application/vnd.api+json

Records returned

The response is of type object.