OBJECT
WholesaleOrder
link GraphQL Schema definition
1 type WholesaleOrder implements Order, ObjectWithAttributes { 2 : String! 3 4 : Int! 5 6 : OrderStatus! 7 8 # Arguments 9 # includingTax: (self-explanatory) 10 (: Boolean! = true): MonetaryValue! 11 12 # Same as orderDate 13 # 14 # Arguments 15 # format: ISO-8601 16 (: String = "Y-m-d\\TH:i:sP"): DateTimeTz! 17 18 # Arguments 19 # format: ISO-8601 20 (: String = "Y-m-d\\TH:i:sP"): DateTimeTz! 21 22 # Same as createdAt 23 # 24 # Arguments 25 # format: ISO-8601 26 (: String = "Y-m-d\\TH:i:sP"): DateTimeTz! 27 28 # Required permission: Order.userIP:read 29 : String 30 31 # Required permission: Order.internalComment:read 32 : String 33 34 : String! 35 36 : Float! 37 38 # Required permission: Order.attributes:read 39 # 40 # All elements are always returned 41 # 42 # Arguments 43 # where: (self-explanatory) 44 (: AssignedAttributeFilter): [Attribute!]! 45 46 # Required permission: Order.billingAddress:read 47 : Address 48 49 # Required permission: none 50 : Country 51 52 # Required permission: Order:read 53 # 54 # All elements are always returned 55 : [OrderDiscount!]! 56 57 # Required permission: EmailHistory:read 58 # 59 # Limit must be in range 1 - 200 60 # 61 # Arguments 62 # where: (self-explanatory) 63 # sort: (self-explanatory) 64 # limit: (self-explanatory) 65 # page: (self-explanatory) 66 (: EmailHistoryFilter, : [EmailHistorySort!] = [id_DESC], : Int = 20, : Int = 1): [WholesaleEmailHistoryEntry!]! 67 68 # Required permission: OrderHistory:read 69 # 70 # Limit must be in range 1 - 200 71 # 72 # Arguments 73 # where: (self-explanatory) 74 # sort: (self-explanatory) 75 # limit: (self-explanatory) 76 # page: (self-explanatory) 77 (: OrderHistoryFilter, : [OrderHistorySort!] = [id_DESC], : Int = 20, : Int = 1): [WholesaleOrderHistoryEntry!]! 78 79 # Required permission: none 80 : Language 81 82 # Limit is optional, but if the order has too many lines (thousands), it's recommended to set the limit 83 # 84 # Required permission: Order:read 85 # 86 # Limit is optional 87 # 88 # Arguments 89 # includeFullyCancelled: (self-explanatory) 90 # limit: (self-explanatory) 91 # page: (self-explanatory) 92 (: Boolean = false, : Int, : Int = 1): [OrderLine!]! 93 94 # Required permission: Market:read 95 # 96 # Store restrictions apply. 97 : Market 98 99 # Required permission: Order:read 100 # 101 # All elements are always returned 102 : [OrderDocument!]! 103 104 # Required permission: StorePlugin:read 105 # 106 # Store restrictions apply. 107 : StorePlugin 108 109 # Required permission: PaymentHistory:read 110 # 111 # Limit must be in range 1 - 200 112 # 113 # Arguments 114 # where: (self-explanatory) 115 # sort: (self-explanatory) 116 # limit: (self-explanatory) 117 # page: (self-explanatory) 118 (: PaymentHistoryEntryFilter, : [PaymentHistoryEntrySort!] = [id_DESC], : Int = 20, : Int = 1): [PaymentHistoryEntry!]! 119 120 # Required permission: Pricelist:read 121 # 122 # Store restrictions apply. 123 : Pricelist! 124 125 # Required permission: Return:read 126 # 127 # All elements are always returned 128 # 129 # Store restrictions apply. 130 : [WholesaleReturn!]! 131 132 # Required permission: Shipment:read 133 # 134 # All elements are always returned 135 # 136 # Store restrictions apply. 137 : [WholesaleShipment!]! 138 139 # Required permission: Order.shippingAddress:read 140 : Address 141 142 # Required permission: ShippingOption:read 143 : ShippingPriceGroup 144 145 # Required permission: none 146 : CountryState 147 148 # Required permission: Store:read 149 # 150 # Store restrictions apply. 151 : Store! 152 153 # Required permission: Order:read 154 : OrderTotals! 155 156 # All elements are always returned 157 : [TaxBreakdownLine!]! 158 159 # Required permission: AllocationRule:read 160 : AllocationRule 161 162 : BuyerInfo! 163 164 : Boolean! 165 166 : Boolean! 167 168 : Boolean! 169 170 : Boolean! 171 172 : Boolean! 173 174 : Boolean! 175 176 # Arguments 177 # includeWaitingForConfirmation: (self-explanatory) 178 (: Boolean! = true): Int! 179 180 : String 181 182 : String 183 184 # Required permission: Account:read 185 # 186 # Store restrictions apply. 187 : Account 188 189 # Required permission: Buyer:read 190 # 191 # Store restrictions apply. 192 : Buyer 193 194 # Required permission: Commission:read 195 # 196 # All elements are always returned 197 : [Commission!]! 198 199 # Required permission: DeliveryWindow:read 200 # 201 # Limit must be in range 1 - 200 202 # 203 # Store restrictions apply. 204 # 205 # Arguments 206 # where: (self-explanatory) 207 # sort: (self-explanatory) 208 # limit: (self-explanatory) 209 # page: (self-explanatory) 210 (: DeliveryWindowFilter, : [DeliveryWindowSort!] = [id_ASC], : Int = 20, : Int = 1): [DeliveryWindow!]! 211 212 # Required permission: ShippingTerms:read 213 # 214 # Store restrictions apply. 215 : ShippingTerms 216 217 # Required permission: PaymentTerms:read 218 # 219 # Store restrictions apply. 220 : PaymentTerms 221 222 # Required permission: Order:read 223 # 224 # All elements are always returned 225 : [OrderAttachment!]! 226 227 # Arguments 228 # format: ISO-8601 229 (: String = "Y-m-d\\TH:i:sP"): DateTimeTz 230 231 # Arguments 232 # format: ISO-8601 233 (: String = "Y-m-d\\TH:i:sP"): DateTimeTz 234 235 # A note on an order if the Account doesn't want the order after a certain date. 236 # The order is not automatically cancelled on the Cancel Date, it is a note for sales staff. 237 # It's not a date when the order is actually canceled. 238 # 239 # Arguments 240 # format: ISO-8601 241 (: String = "Y-m-d\\TH:i:sP"): DateTimeTz 242 243 # Required permission: Account:read 244 : AddressBookEntry 245 246 }