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