Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Commerce Transactions

List Transactions

Supported for:

shopify square

get/v2/commerce/transactions

Query parameters

connectionUuidstring required

Unique connection identifier.

offsetnumber

The offset is the position in the dataset of a particular record.

limitnumber

This is the size of the results set you would like (default: 100).

orderBystring
idstring
status'success' | 'failed' | 'pending' | 'cancelled' | 'approved' | 'scheduled' | 'other' | 'unknown'
startDatestring
endDatestring

Response

countnumber required

Example response

{
  "data": [
    {
      "id": "699519475",
      "orderId": "217130470",
      "paymentMethodType": "digital",
      "totalAmount": -3.45,
      "currencyRef": {
        "symbol": "CAD",
        "name": "Canadian Dollar"
      },
      "transactionSourceRefs": [
        {
          "id": "1006917261",
          "type": "payment"
        }
      ],
      "transactionType": "transfer",
      "createdDate": "2022-03-11T11:29:03-05:00",
      "sourceModifiedDate": "2022-03-11T11:29:03-05:00",
      "status": "pending"
    }
  ],
  "count": 1,
  "meta": {
    "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
    "businessName": "Railz",
    "serviceName": "xero",
    "reportId": [
      "5fad8a342a88364234392fb5"
    ],
    "createdAt": "2020-11-25T01:02:03Z",
    "updatedAt": "2020-11-30T01:02:03Z",
    "startDate": "2020-11-25T01:02:03Z",
    "endDate": "2020-11-30T01:02:03Z"
  }
}