Lists transactions that match specified search criteria

GET /V1/transactions

Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • items array[object] Required

      Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.

      Hide items attributes Show items attributes object
      • transaction_id integer Required

        Transaction ID.

      • parent_id integer

        The parent ID for the transaction. Otherwise, null.

      • order_id integer Required

        Order ID.

      • payment_id integer Required

        Payment ID.

      • txn_id string Required

        Transaction business ID.

      • parent_txn_id string Required

        Parent transaction business ID.

      • txn_type string Required

        Transaction type.

      • is_closed integer Required

        Is-closed flag value.

      • additional_information array[string]

        Array of additional information. Otherwise, null.

      • created_at string Required

        Created-at timestamp.

      • child_transactions array[object] Required

        Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.

        Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Sales\Api\Data\TransactionInterface

    • search_criteria object Required

      Search criteria interface.

      Hide search_criteria attributes Show search_criteria attributes object
      • filter_groups array[object] Required

        Groups two or more filters together using a logical OR

        Hide filter_groups attribute Show filter_groups attribute object
        • filters array[object]

          Filter which can be used by any methods from service layer.

          Hide filters attributes Show filters attributes object
      • sort_orders array[object]

        Data object for sort order.

        Hide sort_orders attributes Show sort_orders attributes object
      • page_size integer

        Page size.

      • current_page integer

        Current page.

    • total_count integer Required

      Total count.
  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Hide errors attributes Show errors attributes object
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
  • default

    Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Hide errors attributes Show errors attributes object
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/transactions 
curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/transactions
Response examples (200) 
{
  "items": [
    {
      "transaction_id": 42,
      "parent_id": 42,
      "order_id": 42,
      "payment_id": 42,
      "txn_id": "string",
      "parent_txn_id": "string",
      "txn_type": "string",
      "is_closed": 42,
      "additional_information": [
        "string"
      ],
      "created_at": "string",
      "child_transactions": [
        {}
      ],
      "extension_attributes": {}
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 42,
    "current_page": 42
  },
  "total_count": 42
}
Response examples (401) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}