INTERFACE
Order
link GraphQL Schema definition
1 interface Order { 2 String! : 3 4 Int! : 5 6 OrderStatus! : 7 8 # Arguments 9 # includingTax: (self-explanatory) 10 Boolean! = true): MonetaryValue! ( : 11 12 # Arguments 13 # format: ISO-8601 14 String = "Y-m-d\\TH:i:sP"): String! ( : 15 16 # Arguments 17 # format: ISO-8601 18 String = "Y-m-d\\TH:i:sP"): String! ( : 19 20 # Arguments 21 # format: ISO-8601 22 String = "Y-m-d\\TH:i:sP"): String! ( : 23 24 # Required permission: Order.userIP:read 25 String : 26 27 # Required permission: Order.internalComment:read 28 String : 29 30 String! : 31 32 # Required permission: Order.attributes:read 33 # 34 # All elements are always returned 35 Attribute!]! : [ 36 37 # Required permission: Order.billingAddress:read 38 Address : 39 40 # Required permission: none 41 Country : 42 43 # Required permission: Order:read 44 # 45 # All elements are always returned 46 OrderDiscount!]! : [ 47 48 # Required permission: EmailHistory:read 49 # 50 # Limit must be in range 1 - 200 51 # 52 # Arguments 53 # where: (self-explanatory) 54 # sort: (self-explanatory) 55 # limit: (self-explanatory) 56 # page: (self-explanatory) 57 ( 58 EmailHistoryFilter, : 59 EmailHistorySort!] = [id_DESC], : [ 60 Int = 20, : 61 Int = 1 : 62 ): [EmailHistoryEntry!]! 63 64 # Required permission: OrderHistory:read 65 # 66 # Limit must be in range 1 - 200 67 # 68 # Arguments 69 # where: (self-explanatory) 70 # sort: (self-explanatory) 71 # limit: (self-explanatory) 72 # page: (self-explanatory) 73 ( 74 OrderHistoryFilter, : 75 OrderHistorySort!] = [id_DESC], : [ 76 Int = 20, : 77 Int = 1 : 78 ): [OrderHistoryEntry!]! 79 80 # Required permission: none 81 Language : 82 83 # Required permission: Order:read 84 # 85 # All elements are always returned 86 OrderLine!]! : [ 87 88 # Required permission: Market:read 89 # 90 # Store restrictions apply. 91 Market : 92 93 # Required permission: Order:read 94 # 95 # All elements are always returned 96 OrderDocument!]! : [ 97 98 # Required permission: StorePlugin:read 99 # 100 # Store restrictions apply. 101 StorePlugin : 102 103 # Required permission: PaymentHistory:read 104 # 105 # Limit must be in range 1 - 200 106 # 107 # Arguments 108 # where: (self-explanatory) 109 # sort: (self-explanatory) 110 # limit: (self-explanatory) 111 # page: (self-explanatory) 112 ( 113 PaymentHistoryEntryFilter, : 114 PaymentHistoryEntrySort!] = [id_DESC], : [ 115 Int = 20, : 116 Int = 1 : 117 ): [PaymentHistoryEntry!]! 118 119 # Required permission: Pricelist:read 120 # 121 # Store restrictions apply. 122 Pricelist! : 123 124 # Required permission: Return:read 125 # 126 # All elements are always returned 127 # 128 # Store restrictions apply. 129 Return!]! : [ 130 131 # Required permission: Shipment:read 132 # 133 # All elements are always returned 134 # 135 # Store restrictions apply. 136 Shipment!]! : [ 137 138 # Required permission: Order.shippingAddress:read 139 Address : 140 141 # Required permission: ShippingOption:read 142 # 143 # Store restrictions apply. 144 ShippingPriceGroup : 145 146 # Required permission: none 147 CountryState : 148 149 # Required permission: Store:read 150 # 151 # Store restrictions apply. 152 Store! : 153 154 # Required permission: Order:read 155 OrderTotals! : 156 157 # All elements are always returned 158 TaxBreakdownLine!]! : [ 159 160 # Required permission: AllocationRule:read 161 AllocationRule : 162 163 Boolean! : 164 165 Boolean! : 166 167 Boolean! : 168 169 Boolean! : 170 171 }
link Required by
- Affiliate
- AppliedDiscount
- BundleItemOrderLine
- BundleOrderLine
- Commission
- DirectToConsumerOrder
- EmailHistoryEntry
- GiftCertificateOrderLine
- OrderEdge
- OrderHistoryEntry
- OrderLine
- PaymentHistoryEntry
- ProductOrderLine
- Purchaser
- Query The main queries are here, click to expand
- Return
- Shipment
- Store
- Subscription
- SubscriptionContract
- WholesaleOrder