flamingo.me/flamingo-commerce/v3@v3.11.0/test/integrationtest/projecttest/graphql/schema/flamingo.me_flamingo-commerce_v3_cart_interfaces_graphql-Service.graphql (about)

     1  type Commerce_Cart_DecoratedCart {
     2      cart: Commerce_Cart_Cart!
     3      decoratedDeliveries: [Commerce_Cart_DecoratedDelivery!]
     4      getDecoratedDeliveryByCode(deliveryCode: String!): Commerce_Cart_DecoratedDelivery
     5      getAllPaymentRequiredItems: Commerce_Cart_PricedItems!
     6      cartSummary: Commerce_Cart_Summary!
     7  }
     8  
     9  type Commerce_Cart_Summary {
    10      discounts: Commerce_Cart_AppliedDiscounts!
    11      totalDiscountAmount: Commerce_Price
    12      totalGiftCardAmount: Commerce_Price
    13      grandTotalWithGiftCards: Commerce_Price
    14      sumTotalDiscountWithGiftCardsAmount: Commerce_Price
    15      hasAppliedDiscounts: Boolean!
    16      sumTaxes: Commerce_Cart_Taxes
    17      sumPaymentSelectionCartSplitValueAmountByMethods(methods: [String!]): Commerce_Price
    18      sumPaymentSelectionCartSplitPriceAmountByMethods(methods: [String!]): Commerce_Price
    19  }
    20  
    21  type Commerce_Cart_Cart {
    22      id: ID!
    23      entityID: String!
    24      billingAddress: Commerce_Cart_Address
    25      purchaser: Commerce_Cart_Person
    26      deliveries: [Commerce_Cart_Delivery!]
    27      additionalData: Commerce_Cart_AdditionalData!
    28      paymentSelection: Commerce_Cart_PaymentSelection
    29      belongsToAuthenticatedUser: Boolean!
    30      authenticatedUserID: String!
    31      appliedCouponCodes: [Commerce_Cart_CouponCode!]
    32      defaultCurrency: String!
    33      totalitems: [Commerce_Cart_Totalitem!]
    34      itemCount: Int!
    35      productCount: Int!
    36      isPaymentSelected: Boolean!
    37      grandTotal: Commerce_Price!
    38      sumTotalTaxAmount: Commerce_Price!
    39      subTotalNet: Commerce_Price!
    40      appliedGiftCards: [Commerce_Cart_AppliedGiftCard!]
    41      getDeliveryByCode(deliveryCode: String!): Commerce_Cart_Delivery
    42      getDeliveryCodes: [String!]
    43  
    44      getMainShippingEMail: String!
    45      isEmpty: Boolean!
    46      hasDeliveryForCode(deliveryCode: String!): Boolean!
    47  
    48      getDeliveryByItemID(itemID: String!): Commerce_Cart_Delivery!
    49      getByItemID(itemID: String!): Commerce_Cart_Item!
    50      getTotalQty(marketPlaceCode: String!, variantCode: String!): Int
    51      getByExternalReference(ref: String!): Commerce_Cart_Item!
    52  
    53      getVoucherSavings: Commerce_Price!
    54      getCartTeaser: Commerce_Cart_Teaser!
    55  
    56      shippingNet: Commerce_Price!
    57      shippingNetWithDiscounts: Commerce_Price!
    58      shippingGross: Commerce_Price!
    59      shippingGrossWithDiscounts: Commerce_Price!
    60  
    61      hasShippingCosts: Boolean!
    62      allShippingTitles: [String!]
    63  
    64      subTotalGross: Commerce_Price!
    65      subTotalGrossWithDiscounts: Commerce_Price!
    66      subTotalNetWithDiscounts: Commerce_Price!
    67      totalDiscountAmount: Commerce_Price!
    68      nonItemRelatedDiscountAmount: Commerce_Price!
    69      itemRelatedDiscountAmount: Commerce_Price!
    70      hasAppliedCouponCode: Boolean!
    71  
    72      getPaymentReference: String!
    73      getTotalItemsByType(typeCode: String!): [Commerce_Cart_Totalitem!]
    74      grandTotalCharges: Commerce_Price_Charges!
    75  
    76      hasAppliedGiftCards: Boolean!
    77      hasRemainingGiftCards: Boolean!
    78  }
    79  
    80  type Commerce_Cart_PricedItems {
    81      cartItems:  [Commerce_Cart_PricedCartItem!]
    82      shippingItems:  [Commerce_Cart_PricedShippingItem!]
    83      totalItems: [Commerce_Cart_PricedTotalItem!]
    84  }
    85  
    86  type Commerce_Cart_PricedCartItem {
    87      amount: Commerce_Price!
    88      itemID: String!
    89  }
    90  
    91  type Commerce_Cart_PricedShippingItem {
    92      amount: Commerce_Price!
    93      deliveryInfoCode: String!
    94  }
    95  
    96  type Commerce_Cart_PricedTotalItem {
    97      amount: Commerce_Price!
    98      code: String!
    99  }
   100  
   101  type Commerce_Cart_Tax {
   102      amount: Commerce_Price!
   103      type: String!
   104      rate: Float
   105  }
   106  
   107  type Commerce_Cart_Taxes {
   108      items: [Commerce_Cart_Tax]!
   109      getByType(taxType: String): Commerce_Cart_Tax!
   110  }
   111  
   112  type Commerce_Cart_Teaser {
   113      productCount:  Int
   114      ItemCount:     Int
   115      DeliveryCodes: [String]
   116  }
   117  
   118  interface Commerce_Cart_PaymentSelection {
   119      gateway: String!
   120      totalValue: Commerce_Price!
   121      cartSplit: [Commerce_Cart_PaymentSelection_Split!]
   122  }
   123  
   124  type Commerce_Cart_PaymentSelection_Split {
   125      qualifier: Commerce_Cart_PaymentSelection_SplitQualifier!
   126      charge: Commerce_Price_Charge!
   127  }
   128  
   129  type Commerce_Cart_PaymentSelection_SplitQualifier {
   130      type: String!
   131      method: String!
   132      reference: String!
   133  }
   134  
   135  type Commerce_Cart_DefaultPaymentSelection implements Commerce_Cart_PaymentSelection {
   136      gateway: String!
   137      totalValue: Commerce_Price!
   138      cartSplit: [Commerce_Cart_PaymentSelection_Split!]
   139  }
   140  
   141  type Commerce_Cart_DecoratedDelivery {
   142      delivery: Commerce_Cart_Delivery!
   143      decoratedItems: [Commerce_Cart_DecoratedItem!]
   144  }
   145  
   146  type Commerce_Cart_Delivery {
   147      deliveryInfo: Commerce_Cart_DeliveryInfo
   148      cartitems: [Commerce_Cart_Item!]
   149      shippingItem: Commerce_Cart_ShippingItem
   150      subTotalGross: Commerce_Price
   151      grandTotal: Commerce_Price
   152      sumTotalTaxAmount: Commerce_Price
   153      subTotalNet: Commerce_Price
   154      totalDiscountAmount: Commerce_Price
   155      nonItemRelatedDiscountAmount: Commerce_Price
   156      itemRelatedDiscountAmount: Commerce_Price
   157      subTotalGrossWithDiscounts: Commerce_Price
   158      subTotalNetWithDiscounts: Commerce_Price!
   159      hasItems: Boolean!
   160  }
   161  
   162  type Commerce_Cart_DeliveryInfo {
   163      code: String!
   164      workflow: String!
   165      method: String!
   166      carrier: String!
   167      deliveryLocation: Commerce_Cart_DeliveryLocation
   168      desiredTime: Time
   169      additionalData: Commerce_Cart_CustomAttributes!
   170  }
   171  
   172  type Commerce_Cart_DeliveryLocation  {
   173      type: String!
   174      address: Commerce_Cart_Address
   175      useBillingAddress: Boolean!
   176      code: String!
   177  }
   178  
   179  type Commerce_Cart_ShippingItem {
   180      title: String!
   181      priceNet: Commerce_Price!
   182      taxAmount: Commerce_Price!
   183      priceGross: Commerce_Price!
   184      appliedDiscounts: Commerce_Cart_AppliedDiscounts!
   185      totalWithDiscountInclTax: Commerce_Price!
   186      tax: Commerce_Cart_Tax!
   187  }
   188  
   189  type Commerce_Cart_AppliedDiscounts {
   190      items: [Commerce_Cart_AppliedDiscount!]
   191      byCampaignCode(campaignCode: String):  Commerce_Cart_AppliedDiscounts!
   192      byType(filterType: String): Commerce_Cart_AppliedDiscounts!
   193  }
   194  
   195  type Commerce_Cart_AppliedDiscount {
   196      campaignCode:  String!
   197      couponCode:    String!
   198      label:         String!
   199      applied:       Commerce_Price!
   200      type:          String!
   201      isItemRelated: Boolean!
   202      sortOrder:     Int!
   203  }
   204  
   205  type Commerce_Cart_DecoratedItem {
   206      item: Commerce_Cart_Item
   207      product: Commerce_Product
   208  }
   209  
   210  type Commerce_Cart_Item {
   211      id: ID!
   212      externalReference: String!
   213      marketplaceCode: String!
   214      variantMarketPlaceCode: String!
   215      productName: String!
   216      sourceID: String!
   217      qty: Int!
   218      additionalDataKeys: [String!]
   219      additionalDataValues: [String!]
   220      getAdditionalData(key: String!): String
   221      hasAdditionalDataKey(key: String!): Boolean
   222      singlePriceGross: Commerce_Price!
   223      singlePriceNet: Commerce_Price!
   224      rowPriceGross: Commerce_Price!
   225      rowPriceNet: Commerce_Price!
   226      appliedDiscounts: Commerce_Cart_AppliedDiscounts!
   227      #    rowTaxes: Commerce_Taxes!
   228  }
   229  
   230  type Commerce_Cart_Address {
   231      vat:                    String!
   232      firstname:              String!
   233      lastname:               String!
   234      middleName:             String!
   235      title:                  String!
   236      salutation:             String!
   237      street:                 String!
   238      streetNr:               String!
   239      additionalAddressLines: [String!]
   240      company:                String!
   241      city:                   String!
   242      postCode:               String!
   243      state:                  String!
   244      regionCode:             String!
   245      country:                String!
   246      countryCode:            String!
   247      telephone:              String!
   248      email:                  String!
   249  }
   250  
   251  type Commerce_Cart_Person {
   252      address: Commerce_Cart_Address
   253      personalDetails: Commerce_Cart_PersonalDetails!
   254      existingCustomerData: Commerce_Cart_ExistingCustomerData
   255  }
   256  
   257  type Commerce_Cart_ExistingCustomerData {
   258      id: ID!
   259  }
   260  
   261  type Commerce_Cart_PersonalDetails {
   262      dateOfBirth: String!
   263      passportCountry: String!
   264      passportNumber: String!
   265      nationality: String!
   266  }
   267  
   268  type Commerce_Cart_AdditionalData {
   269      customAttributes: Commerce_Cart_CustomAttributes!
   270      reservedOrderID: String!
   271  }
   272  
   273  type Commerce_Cart_CustomAttributes {
   274      "Get specific attribute by key"
   275      get(key: String!): Commerce_Cart_KeyValue
   276  }
   277  
   278  type Commerce_Cart_KeyValue {
   279      key: String!
   280      value: String!
   281  }
   282  
   283  type Commerce_Cart_Totalitem {
   284      code: String!
   285      title: String!
   286      price: Commerce_Price!
   287      type: String!
   288  }
   289  
   290  type Commerce_Cart_CouponCode {
   291      code: String!
   292  }
   293  
   294  type Commerce_Cart_AppliedGiftCard {
   295      code: String!
   296      applied: Commerce_Price!
   297      remaining: Commerce_Price!
   298      hasRemaining: Boolean!
   299  }
   300  
   301  type Commerce_Cart_ValidationResult {
   302      hasCommonError:        Boolean!
   303      commonErrorMessageKey: String!
   304      itemResults:           [Commerce_Cart_ItemValidationError!]
   305  }
   306  
   307  type Commerce_Cart_ItemValidationError {
   308      itemID:          String!
   309      errorMessageKey: String!
   310  }
   311  
   312  
   313  type Commerce_Cart_QtyRestrictionResult {
   314      isRestricted:        Boolean!
   315      maxAllowed:          Int!
   316      remainingDifference: Int!
   317      restrictorName:      String!
   318  }
   319  
   320  type Commerce_Cart_PlacedOrderInfo {
   321      orderNumber:    String!
   322      deliveryCode:   String!
   323  }
   324  
   325  type Commerce_Cart_BillingAddressForm {
   326      "Billing address form data"
   327      formData:       Commerce_Cart_AddressForm
   328      "Validation of supplied billing address, empty if address is valid"
   329      validationInfo: Commerce_Cart_Form_ValidationInfo
   330      "Shows if the request was successfully processed"
   331      processed: Boolean
   332  }
   333  
   334  type Commerce_Cart_SelectedPaymentResult {
   335      validationInfo: Commerce_Cart_Form_ValidationInfo
   336      processed: Boolean
   337  }
   338  
   339  type Commerce_Cart_Form_ValidationInfo {
   340      "Field specific validation errors"
   341      fieldErrors: [Commerce_Cart_Form_FieldError!]
   342      "General validation errors"
   343      generalErrors: [Commerce_Cart_Form_Error!]
   344  }
   345  
   346  type Commerce_Cart_Form_Error {
   347      "A key of the error message. Often used for translation"
   348      messageKey: String!
   349      "A speaking error label. Often used to show to end user - in case no translation exists"
   350      defaultLabel: String!
   351  }
   352  
   353  type Commerce_Cart_Form_FieldError {
   354      "A key of the error message. Often used for translation"
   355      messageKey: String!
   356      "A speaking error label. Often used to show to end user - in case no translation exists"
   357      defaultLabel: String!
   358      "Identifier for a form field"
   359      fieldName: String!
   360  }
   361  
   362  type Commerce_Cart_AddressForm {
   363      vat:                    String!
   364      firstname:              String!
   365      lastname:               String!
   366      middleName:             String!
   367      title:                  String!
   368      salutation:             String!
   369      street:                 String!
   370      streetNr:               String!
   371      addressLine1:           String!
   372      addressLine2:           String!
   373      company:                String!
   374      city:                   String!
   375      postCode:               String!
   376      state:                  String!
   377      regionCode:             String!
   378      country:                String!
   379      countryCode:            String!
   380      phoneNumber:            String!
   381      email:                  String!
   382  }
   383  
   384  input Commerce_Cart_AddressFormInput {
   385      vat:                    String
   386      firstname:              String!
   387      lastname:               String!
   388      middleName:             String
   389      title:                  String
   390      salutation:             String
   391      street:                 String
   392      streetNr:               String
   393      addressLine1:           String
   394      addressLine2:           String
   395      company:                String
   396      city:                   String
   397      postCode:               String
   398      state:                  String
   399      regionCode:             String
   400      country:                String
   401      countryCode:            String
   402      phoneNumber:            String
   403      email:                  String!
   404  }
   405  
   406  input Commerce_Cart_DeliveryAddressInput {
   407      "Unique delivery code to identify the delivery"
   408      deliveryCode: String!
   409      "Delivery address form data"
   410      deliveryAddress: Commerce_Cart_AddressFormInput
   411      "Should the data of the billing address be used for this delivery"
   412      useBillingAddress: Boolean!
   413      "Optional Shipping Method"
   414      method: String
   415      "Optional Shipping Method"
   416      carrier: String
   417      "Optional desired delivery date / time"
   418      desiredTime: Time
   419  }
   420  
   421  type Commerce_Cart_DeliveryAddressForm {
   422      "Unique delivery code to identify the delivery"
   423      deliveryCode: String!
   424      "Delivery address form data"
   425      formData:       Commerce_Cart_AddressForm
   426      "Shows if the data of the billing address should be used for this delivery"
   427      useBillingAddress: Boolean!
   428      "Shipping Method"
   429      method: String
   430      "Shipping Carrier"
   431      carrier: String
   432      "Optional desired delivery date / time"
   433      desiredTime: Time
   434  
   435      "Validation of supplied delivery address, empty if address is valid"
   436      validationInfo: Commerce_Cart_Form_ValidationInfo
   437      "Shows if the request was successfully processed"
   438      processed: Boolean
   439  }
   440  
   441  type Commerce_Cart_UpdateDeliveryShippingOptions_Result {
   442      "Shows if the request was successfully processed"
   443      processed: Boolean
   444  }
   445  
   446  input Commerce_Cart_DeliveryShippingOptionInput {
   447      "Unique delivery code to identify an **existing** delivery"
   448      deliveryCode: String!
   449      "Shipping Method"
   450      method: String!
   451      "Shipping Carrier"
   452      carrier: String!
   453  }
   454  
   455  input Commerce_Cart_KeyValueInput {
   456      key: String!
   457      value: String!
   458  }
   459  
   460  input Commerce_Cart_DeliveryAdditionalDataInput {
   461      deliveryCode: String!
   462      additionalData: [Commerce_Cart_KeyValueInput!]!
   463  }
   464  
   465  extend type Query {
   466      Commerce_Cart_DecoratedCart: Commerce_Cart_DecoratedCart!
   467      Commerce_Cart_Validator: Commerce_Cart_ValidationResult!
   468      "Commerce_Cart_QtyRestriction returns if the product is restricted in terms of the allowed quantity for the current cart and the given delivery"
   469      Commerce_Cart_QtyRestriction(marketplaceCode: String!, variantCode: String, deliveryCode: String!): Commerce_Cart_QtyRestrictionResult!
   470  }
   471  
   472  input Commerce_Cart_AddToCartInput {
   473      marketplaceCode: ID!
   474      qty: Int!
   475      deliveryCode: String!
   476      variantMarketplaceCode: String
   477      bundleConfiguration:[Commerce_Cart_ChoiceConfigurationInput!]
   478  }
   479  
   480  input Commerce_Cart_ChoiceConfigurationInput {
   481      identifier: String!
   482      marketplaceCode: String!
   483      variantMarketplaceCode: String
   484      qty: Int!
   485  }
   486  
   487  extend type Mutation {
   488      Commerce_Cart_AddToCart(addToCartInput: Commerce_Cart_AddToCartInput!): Commerce_Cart_DecoratedCart!
   489      Commerce_Cart_DeleteCartDelivery(deliveryCode: String!): Commerce_Cart_DecoratedCart!
   490      Commerce_Cart_DeleteItem(itemID: ID!, deliveryCode: String!): Commerce_Cart_DecoratedCart!
   491      Commerce_Cart_UpdateItemQty(itemID: ID!, deliveryCode: String!, qty: Int!): Commerce_Cart_DecoratedCart!
   492      "Updates the bundle configuration of an existing item"
   493      Commerce_Cart_UpdateItemBundleConfig(itemID: ID!, bundleConfig: [Commerce_Cart_ChoiceConfigurationInput!]!): Commerce_Cart_DecoratedCart!
   494      "Adds/Updates the Billing Address of the current cart"
   495      Commerce_Cart_UpdateBillingAddress(addressForm: Commerce_Cart_AddressFormInput): Commerce_Cart_BillingAddressForm!
   496      Commerce_Cart_UpdateSelectedPayment(gateway: String!, method: String!): Commerce_Cart_SelectedPaymentResult!
   497      Commerce_Cart_ApplyCouponCodeOrGiftCard(code: String!): Commerce_Cart_DecoratedCart
   498      Commerce_Cart_RemoveGiftCard(giftCardCode: String!): Commerce_Cart_DecoratedCart
   499      Commerce_Cart_RemoveCouponCode(couponCode: String!): Commerce_Cart_DecoratedCart
   500      "Adds/Updates one/multiple Delivery Addresses"
   501      Commerce_Cart_UpdateDeliveryAddresses(deliveryAdresses: [Commerce_Cart_DeliveryAddressInput!]): [Commerce_Cart_DeliveryAddressForm]!
   502      "Adds/Updates one/multiple Delivery Addresses"
   503      Commerce_Cart_UpdateDeliveryShippingOptions(shippingOptions: [Commerce_Cart_DeliveryShippingOptionInput!]): Commerce_Cart_UpdateDeliveryShippingOptions_Result!
   504      "Cleans current cart"
   505      Commerce_Cart_Clean: Boolean!
   506      "Adds/Updates additional data for the cart"
   507      Commerce_Cart_UpdateAdditionalData(additionalData: [Commerce_Cart_KeyValueInput!]!): Commerce_Cart_DecoratedCart!
   508      "Adds/Updates additional data for the given deliveries"
   509      Commerce_Cart_UpdateDeliveriesAdditionalData(data: [Commerce_Cart_DeliveryAdditionalDataInput!]!): Commerce_Cart_DecoratedCart!
   510  }