flamingo.me/flamingo-commerce/v3@v3.11.0/checkout/interfaces/graphql/schema.graphql (about)

     1  type Commerce_Checkout_StartPlaceOrder_Result {
     2      uuid: String!
     3  }
     4  # Commerce_Checkout_PlaceOrderContext represents the result of the current (running) place order mutation
     5  type Commerce_Checkout_PlaceOrderContext {
     6      # The Cart that is going to be placed
     7      cart: Commerce_Cart_DecoratedCart
     8      # The placed order in case order is already placed
     9      orderInfos: Commerce_Checkout_PlacedOrderInfos
    10      # State depending on the state of payment and place order - state may contain additional infos
    11      state: Commerce_Checkout_PlaceOrderState_State!
    12      # A unique id for the process
    13      uuid: String!
    14  }
    15  
    16  
    17  # Commerce_Checkout_PlacedOrderInfos - infos about the placed orders - typically shown on a suceess page
    18  type Commerce_Checkout_PlacedOrderInfos {
    19      paymentInfos:        [Commerce_Checkout_PlaceOrderPaymentInfo!]
    20      placedOrderInfos:    [Commerce_Cart_PlacedOrderInfo!]
    21      email:               String!
    22  }
    23  
    24  type  Commerce_Checkout_PlaceOrderPaymentInfo {
    25      gateway:         String!
    26      paymentProvider: String!
    27      method:          String!
    28      amount:          Commerce_Price!
    29      title:           String!
    30  }
    31  
    32  
    33  interface Commerce_Checkout_PlaceOrderState_State {
    34      name: String!
    35  }
    36  
    37  type Commerce_Checkout_PlaceOrderState_State_Wait implements Commerce_Checkout_PlaceOrderState_State {
    38      name: String!
    39  }
    40  
    41  type Commerce_Checkout_PlaceOrderState_State_WaitForCustomer implements Commerce_Checkout_PlaceOrderState_State {
    42      name: String!
    43  }
    44  
    45  type Commerce_Checkout_PlaceOrderState_State_Success implements Commerce_Checkout_PlaceOrderState_State {
    46      name: String!
    47  }
    48  
    49  type Commerce_Checkout_PlaceOrderState_State_Failed implements Commerce_Checkout_PlaceOrderState_State {
    50      name: String!
    51      reason: Commerce_Checkout_PlaceOrderState_State_FailedReason!
    52  }
    53  
    54  type Commerce_Checkout_PlaceOrderState_State_ShowIframe implements Commerce_Checkout_PlaceOrderState_State {
    55      name: String!
    56      URL: String!
    57  }
    58  
    59  type Commerce_Checkout_PlaceOrderState_State_ShowHTML implements Commerce_Checkout_PlaceOrderState_State {
    60      name: String!
    61      HTML: String!
    62  }
    63  
    64  type Commerce_Checkout_PlaceOrderState_State_Redirect implements Commerce_Checkout_PlaceOrderState_State {
    65      name: String!
    66      URL: String!
    67  }
    68  
    69  type Commerce_Checkout_PlaceOrderState_State_TriggerClientSDK implements Commerce_Checkout_PlaceOrderState_State {
    70      name: String!
    71      URL: String!
    72      data: String!
    73  }
    74  
    75  type Commerce_Checkout_PlaceOrderState_State_ShowWalletPayment implements Commerce_Checkout_PlaceOrderState_State {
    76      name: String!
    77      "Wallet payment method that was chosen previously"
    78      paymentMethod: String!
    79      "Information needed to create a payment using the PaymentRequest API"
    80      paymentRequestAPI: Commerce_Checkout_PlaceOrderState_PaymentRequestAPI!
    81  }
    82  
    83  type Commerce_Checkout_PlaceOrderState_PaymentRequestAPI {
    84      "Contains the JSON encoded method data for the PaymentRequest API"
    85      methodData: String!
    86      "Contains the JSON encoded details for the PaymentRequest API"
    87      details: String!
    88      "Contains the JSON encoded options for the PaymentRequest API"
    89      options: String!
    90      "Optional endpoint used for obtaining a merchant session, not set if the wallet payment doesn't require a merchant validation"
    91      merchantValidationURL: String
    92      "Endpoint to sent completed payment to"
    93      completeURL: String!
    94  }
    95  
    96  type Commerce_Checkout_PlaceOrderState_State_PostRedirect implements Commerce_Checkout_PlaceOrderState_State {
    97      name: String!
    98      URL: String!
    99      Parameters: [Commerce_Checkout_PlaceOrderState_Form_Parameter!]
   100  }
   101  
   102  interface Commerce_Checkout_PlaceOrderState_State_FailedReason {
   103      reason: String
   104  }
   105  
   106  
   107  type Commerce_Checkout_PlaceOrderState_State_FailedReason_Error implements Commerce_Checkout_PlaceOrderState_State_FailedReason {
   108      reason: String
   109  }
   110  
   111  type Commerce_Checkout_PlaceOrderState_State_FailedReason_PaymentError implements Commerce_Checkout_PlaceOrderState_State_FailedReason {
   112      reason: String
   113  }
   114  
   115  type Commerce_Checkout_PlaceOrderState_State_FailedReason_CanceledByCustomer implements Commerce_Checkout_PlaceOrderState_State_FailedReason {
   116      reason: String
   117  }
   118  
   119  type Commerce_Checkout_PlaceOrderState_State_FailedReason_PaymentCanceledByCustomer implements Commerce_Checkout_PlaceOrderState_State_FailedReason {
   120      reason: String
   121  }
   122  
   123  type Commerce_Checkout_PlaceOrderState_State_FailedReason_CartValidationError implements Commerce_Checkout_PlaceOrderState_State_FailedReason {
   124      reason: String
   125      validationResult: Commerce_Cart_ValidationResult!
   126  }
   127  
   128  type Commerce_Checkout_PlaceOrderState_Form_Parameter {
   129      key: String!
   130      value: [String!]
   131  }
   132  
   133  extend type Query {
   134      # Is there a active place order process
   135      Commerce_Checkout_ActivePlaceOrder: Boolean!
   136      Commerce_Checkout_CurrentContext: Commerce_Checkout_PlaceOrderContext!
   137  }
   138  
   139  extend type Mutation {
   140      # Starts a new process and will replace existing ones
   141      Commerce_Checkout_StartPlaceOrder(returnUrl: String!): Commerce_Checkout_StartPlaceOrder_Result!
   142      # Cancels to current running place order process, possible if state is not final
   143      Commerce_Checkout_CancelPlaceOrder: Boolean!
   144      # Clears the last stored place order process
   145      Commerce_Checkout_ClearPlaceOrder: Boolean!
   146      # Gets the last stored place order state and ensures that the state machine proceeds, non blocking
   147      Commerce_Checkout_RefreshPlaceOrder: Commerce_Checkout_PlaceOrderContext!
   148      # Gets the most recent place order state by waiting for the state machine to proceed, therefore blocking
   149      Commerce_Checkout_RefreshPlaceOrderBlocking: Commerce_Checkout_PlaceOrderContext!
   150  }