GET
/
admin
/
store-credit-accounts
/
{id}
/
transactions
cURL
curl '{backend_url}/admin/store-credit-accounts/{id}/transactions' \
-H 'Authorization: Bearer {access_token}'
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "transactions": [
    {
      "id": "<string>",
      "account_id": "<string>",
      "transaction_group_id": "<string>",
      "type": "credit",
      "amount": 123,
      "account": {
        "customer": {
          "id": "<string>",
          "has_account": true,
          "groups": [
            {
              "id": "<string>",
              "name": "<string>",
              "customers": [
                {}
              ],
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ],
          "email": "jsmith@example.com",
          "default_billing_address_id": "<string>",
          "default_shipping_address_id": "<string>",
          "company_name": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "addresses": [
            {
              "id": "<string>",
              "address_name": "<string>",
              "is_default_shipping": true,
              "is_default_billing": true,
              "customer_id": "<string>",
              "company": "<string>",
              "first_name": "<string>",
              "last_name": "<string>",
              "address_1": "<string>",
              "address_2": "<string>",
              "city": "<string>",
              "country_code": "us",
              "province": "us-ca",
              "postal_code": "<string>",
              "phone": "<string>",
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ],
          "phone": "<string>",
          "metadata": {},
          "created_by": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z"
        },
        "id": "<string>",
        "customer_id": "<string>",
        "currency_code": "usd",
        "credits": 123,
        "debits": 123,
        "balance": 123,
        "transaction_groups": [
          {
            "id": "<string>",
            "code": "<string>",
            "credits": 123,
            "debits": 123,
            "balance": 123,
            "account": {},
            "metadata": {}
          }
        ],
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "note": "<string>",
      "reference": "<string>",
      "reference_id": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "estimate_count": 123
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The store credit account's ID.

Query Parameters

​
id

Filter by a transaction ID.

​
transaction_group_id

Filter by a transaction group ID.

​
created_at
object

Filter by a transaction's creation date.

​
updated_at
object

Filter by a transaction's update date.

​
limit
number

Limit the number of items returned in the list.

​
offset
number

The number of items to skip when retrieving a list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

​
fields
string

Comma-separated fields that should be included in the returned data. If a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. Without prefix it will replace the entire default fields.

​
$and
$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

​
$or
$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

​
q
string

Search query to filter the transactions by their searchable fields.

Response

OK

The paginated list of transactions.

​
limit
number
required

The maximum number of transactions to return.

​
offset
number
required

The number of transactions to skip before retrieving the results.

​
count
number
required

The total number of transactions available.

​
transactions
object[]
required

The list of transactions.

​
estimate_count
number

The store credit account's estimate count.