Common objects

In this section

• ApiVersion — A version of the API, as defined by Shopify API versioning. Versions are commonly referred to by their handle (for example, 2021-10).

• CaptureSession — Represents a capture session.

• CaptureSessionRejectionReasonInput — Reason of the capture status.

• CaptureSessionState — Represents a capture’s state.

• CaptureSessionStateCode — Capture state codes.

• CaptureSessionStateRejected — Additional details about a capture’s rejected state.

• CaptureSessionStateRejectedReason — Reasons the capture is rejected.

• CaptureSessionStateResolved — Additional details about a capture’s resolved state.

• CaptureSessionStates — Details about the capture state.

• CaptureSessionStatus — Represents a capture status.

• CaptureSessionStatusCode — Capture status codes.

• CaptureSessionStatusReason — Capture status reason.

• CaptureSessionStatusReasonRejectionCode — Capture rejection reason codes.

• PaymentSession — Represents a payment session.

• PaymentSessionActionsRedirect — The payload required to perform a redirect action.

• PaymentSessionNextAction — Represents the next action expected by the partner.

• PaymentSessionNextActionAction — Partner payment actions.

• PaymentSessionNextActionContext — The context required to perform an action.

• PaymentSessionRejectionReasonInput — Reason of the payment status.

• PaymentSessionState — Represents a payment’s state.

• PaymentSessionStateCode — Payment state codes.

• PaymentSessionStatePending — Additional details about a payment’s pending state.

• PaymentSessionStatePendingReason — Reasons the finalization of the payment is pending.

• PaymentSessionStateRejected — Additional details about a payment’s rejected state.

• PaymentSessionStateRejectedReason — Reasons the payment is rejected.

• PaymentSessionStateResolved — Additional details about a payment’s resolved state.

• PaymentSessionStates — Details about the payment state.

• PaymentSessionStatus — Represents a payment status.

• PaymentSessionStatusCode — Payment status codes.

• PaymentSessionStatusReason — Payment status reason.

• PaymentSessionStatusReasonRejectionCode — Payment rejection reason codes.

• PaymentsAppConfiguration — The production configuration of the payments app.

• QueryRoot — The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.

• RefundSession — Represents a refund session.

• RefundSessionRejectionReasonInput — Reason of the refund status.

• RefundSessionState — Represents a refund’s state.

• RefundSessionStateCode — Refund state codes.

• RefundSessionStateRejected — Additional details about a refund’s rejected state.

• RefundSessionStateRejectedReason — Reasons the refund is rejected.

• RefundSessionStateResolved — Additional details about a refund’s resolved state.

• RefundSessionStates — Details about the refund state.

• RefundSessionStatus — Represents a refund status.

• RefundSessionStatusCode — Refund status codes.

• RefundSessionStatusReason — Refund status reason.

• RefundSessionStatusReasonRejectionCode — Refund rejection reason codes.

• VoidSession — Represents a void session.

• VoidSessionRejectionReasonInput — Reason of the void status.

• VoidSessionState — Represents a void’s state.

• VoidSessionStateCode — Void state codes.

• VoidSessionStateRejected — Additional details about a void’s rejected state.

• VoidSessionStateRejectedReason — Reasons the void is rejected.

• VoidSessionStateResolved — Additional details about a void’s resolved state.

• VoidSessionStates — Details about the void state.

• VoidSessionStatus — Represents a void status.

• VoidSessionStatusCode — Void status codes.

• VoidSessionStatusReason — Void status reason.

• VoidSessionStatusReasonRejectionCode — Void rejection reason codes.

• paymentSessionPending — Change a payment session status to pending. Upon receiving the response from the PaymentSessionPending mutation, you must redirect the customer back to Shopify, using redirectUrl in nextAction. Upon completion, pending payments must be finalized into either a successful or failed state using the paymentSessionResolve or paymentSessionReject mutations. Both sale and authorization payments can be marked as pending.