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.

Query parameters

searchCriteria[filterGroups][0][filters][0][field] string

Field
searchCriteria[filterGroups][0][filters][0][value] string

Value
searchCriteria[filterGroups][0][filters][0][conditionType] string

Condition type
searchCriteria[sortOrders][0][field] string

Sorting field.
searchCriteria[sortOrders][0][direction] string

Sorting direction.
searchCriteria[pageSize] integer

Page size.
searchCriteria[currentPage] integer

Current page.

Responses

200

application/json

application/json application/xml

200 Success.
Hide response attributes Show response attributes object
- items array[object] Required
  
  Array of collection items.
  
  Hide items attributes Show items attributes object
  
  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_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
  
  Array of child transactions.
  
  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
  
  A list of filter groups.
  
  Hide filter_groups attribute Show filter_groups attribute object
  
  Groups two or more filters together using a logical OR
  
  filters array[object]
  
  A list of filters in this group
  
  Hide filters attributes Show filters attributes object
  
  Filter which can be used by any methods from service layer.
  
  field string Required
  
  Field
  
  value string Required
  
  Value
  
  condition_type string
  
  Condition type
  
  sort_orders array[object]
  
  Sort order.
  
  Hide sort_orders attributes Show sort_orders attributes object
  
  Data object for sort order.
  
  field string Required
  
  Sorting field.
  
  direction string Required
  
  Sorting direction.
  
  page_size integer
  
  Page size.
  
  current_page integer
  
  Current page.
- total_count integer Required
  
  Total count.
Hide response attributes Show response attributes object
- items array[object] Required
  
  Array of collection items.
  
  Hide items attributes Show items attributes object
  
  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_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
  
  Array of child transactions.
  
  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
  
  A list of filter groups.
  
  Hide filter_groups attribute Show filter_groups attribute object
  
  Groups two or more filters together using a logical OR
  
  filters array[object]
  
  A list of filters in this group
  
  Hide filters attributes Show filters attributes object
  
  Filter which can be used by any methods from service layer.
  
  field string Required
  
  Field
  
  value string Required
  
  Value
  
  condition_type string
  
  Condition type
  
  sort_orders array[object]
  
  Sort order.
  
  Hide sort_orders attributes Show sort_orders attributes object
  
  Data object for sort order.
  
  field string Required
  
  Sorting field.
  
  direction string Required
  
  Sorting direction.
  
  page_size integer
  
  Page size.
  
  current_page integer
  
  Current page.
- total_count integer Required
  
  Total count.
401

application/json

application/json application/xml

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

application/json

application/json application/xml

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/transactions

curl \
 --request 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 (200)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <items type="array">
    <item>
      <transaction-id type="integer">42</transaction-id>
      <parent-id type="integer">42</parent-id>
      <order-id type="integer">42</order-id>
      <payment-id type="integer">42</payment-id>
      <txn-id>string</txn-id>
      <parent-txn-id>string</parent-txn-id>
      <txn-type>string</txn-type>
      <is-closed type="integer">42</is-closed>
      <additional-information type="array">
        <additional-information>string</additional-information>
      </additional-information>
      <created-at>string</created-at>
      <child-transactions type="array">
        <child-transaction>
        </child-transaction>
      </child-transactions>
      <extension-attributes>
      </extension-attributes>
    </item>
  </items>
  <search-criteria>
    <filter-groups type="array">
      <filter-group>
        <filters type="array">
          <filter>
            <field>string</field>
            <value>string</value>
            <condition-type>string</condition-type>
          </filter>
        </filters>
      </filter-group>
    </filter-groups>
    <sort-orders type="array">
      <sort-order>
        <field>string</field>
        <direction>string</direction>
      </sort-order>
    </sort-orders>
    <page-size type="integer">42</page-size>
    <current-page type="integer">42</current-page>
  </search-criteria>
  <total-count type="integer">42</total-count>
</root>

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 (401)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>

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"
}

Response examples (default)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>