tenderTransactions - admin-graphql - QUERY

Version: 2024-10

Description:

Returns a list of TenderTransactions associated with the shop.

Access Scopes

Arguments

• after: String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
• before: String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
• first: Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
• last: Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
• query: String - A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | point_of_sale_device_id | id | | processed_at | time | | test | boolean | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
• reverse: Boolean - Reverse the order of the underlying list.

Returns

• edges: TenderTransactionEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
• nodes: TenderTransaction! A list of nodes that are contained in TenderTransactionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
• pageInfo: PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.

Examples

• Retrieves a list of tender transactions

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query TenderTransactionList { tenderTransactions(first: 10) { nodes { id order { id } amount { amount currencyCode } user { id } test processedAt remoteReference paymentDetails: transactionDetails { ... on TenderTransactionCreditCardDetails { creditCardCompany creditCardNumber } } paymentMethod } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query TenderTransactionList {\n    tenderTransactions(first: 10) {\n      nodes {\n        id\n        order {\n          id\n        }\n        amount {\n          amount\n          currencyCode\n        }\n        user {\n          id\n        }\n        test\n        processedAt\n        remoteReference\n        paymentDetails: transactionDetails {\n          ... on TenderTransactionCreditCardDetails {\n            creditCardCompany\n            creditCardNumber\n          }\n        }\n        paymentMethod\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query TenderTransactionList {\n    tenderTransactions(first: 10) {\n      nodes {\n        id\n        order {\n          id\n        }\n        amount {\n          amount\n          currencyCode\n        }\n        user {\n          id\n        }\n        test\n        processedAt\n        remoteReference\n        paymentDetails: transactionDetails {\n          ... on TenderTransactionCreditCardDetails {\n            creditCardCompany\n            creditCardNumber\n          }\n        }\n        paymentMethod\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query TenderTransactionList {\n    tenderTransactions(first: 10) {\n      nodes {\n        id\n        order {\n          id\n        }\n        amount {\n          amount\n          currencyCode\n        }\n        user {\n          id\n        }\n        test\n        processedAt\n        remoteReference\n        paymentDetails: transactionDetails {\n          ... on TenderTransactionCreditCardDetails {\n            creditCardCompany\n            creditCardNumber\n          }\n        }\n        paymentMethod\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query TenderTransactionList {\n    tenderTransactions(first: 10) {\n      nodes {\n        id\n        order {\n          id\n        }\n        amount {\n          amount\n          currencyCode\n        }\n        user {\n          id\n        }\n        test\n        processedAt\n        remoteReference\n        paymentDetails: transactionDetails {\n          ... on TenderTransactionCreditCardDetails {\n            creditCardCompany\n            creditCardNumber\n          }\n        }\n        paymentMethod\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query TenderTransactionList {\n  tenderTransactions(first: 10) {\n    nodes {\n      id\n      order {\n        id\n      }\n      amount {\n        amount\n        currencyCode\n      }\n      user {\n        id\n      }\n      test\n      processedAt\n      remoteReference\n      paymentDetails: transactionDetails {\n        ... on TenderTransactionCreditCardDetails {\n          creditCardCompany\n          creditCardNumber\n        }\n      }\n      paymentMethod\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "tenderTransactions": {
        "nodes": [
          {
            "id": "gid://shopify/TenderTransaction/765446009",
            "order": {
              "id": "gid://shopify/Order/148977776"
            },
            "amount": {
              "amount": "11.5",
              "currencyCode": "USD"
            },
            "user": {
              "id": "gid://shopify/StaffMember/902541635"
            },
            "test": false,
            "processedAt": "2005-07-31T15:57:11Z",
            "remoteReference": "1000",
            "paymentDetails": null,
            "paymentMethod": null
          }
        ]
      }
    }
  }