ExShopifySchema.Generator.Graphql.Introspection.Definition.InputObjectType (ExShopifySchema v2025.4.2)

View Source

Fields may accept arguments to configure their behavior. These inputs are often scalars or enums, but they sometimes need to represent more complex values.

https://spec.graphql.org/October2021/#sec-Input-Objects

Example introspection payload

{
  "kind": "INPUT_OBJECT",
  "name": "OrderCaptureInput",
  "description": "The input fields for the authorized transaction to capture and the total amount to capture from it.",
  "fields": null,
  "inputFields": [
    {
      "name": "id",
      "description": "The ID of the order to capture.",
      "type": {
        "kind": "NON_NULL",
        "name": null,
        "ofType": {
          "kind": "SCALAR",
          "name": "ID",
          "ofType": null
        }
      },
      "defaultValue": null,
      "isDeprecated": false,
      "deprecationReason": null
    },
    {
      "name": "parentTransactionId",
      "description": "The ID of the authorized transaction to capture.",
      "type": {
        "kind": "NON_NULL",
        "name": null,
        "ofType": {
          "kind": "SCALAR",
          "name": "ID",
          "ofType": null
        }
      },
      "defaultValue": null,
      "isDeprecated": false,
      "deprecationReason": null
    },
    {
      "name": "amount",
      "description": "The amount to capture. The capture amount can't be greater than the amount of the authorized transaction.",
      "type": {
        "kind": "NON_NULL",
        "name": null,
        "ofType": {
          "kind": "SCALAR",
          "name": "Money",
          "ofType": null
        }
      },
      "defaultValue": null,
      "isDeprecated": false,
      "deprecationReason": null
    },
    {
      "name": "currency",
      "description": "The currency (in ISO format) that's used to capture the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.",
      "type": {
        "kind": "ENUM",
        "name": "CurrencyCode",
        "ofType": null
      },
      "defaultValue": null,
      "isDeprecated": false,
      "deprecationReason": null
    }
  ],
  "interfaces": null,
  "enumValues": null,
  "possibleTypes": null
}

Summary

Types

t()

@type t() ::
  %ExShopifySchema.Generator.Graphql.Introspection.Definition.InputObjectType{
    description: String.t() | nil,
    directives: [
      ExShopifySchema.Generator.Graphql.Introspection.Definition.ConstDirective.t()
    ],
    fields: [
      ExShopifySchema.Generator.Graphql.Introspection.Definition.InputValue.t()
    ],
    name: String.t()
  }

Functions

load_json(json)

@spec load_json(json :: map()) :: t()