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 # Store restrictions apply. 89 # 90 # Arguments 91 # includeFullyCancelled: (self-explanatory) 92 # limit: (self-explanatory) 93 # page: (self-explanatory) 94 (: Boolean = false, : Int, : Int = 1): [OrderLine!]! 95 96 # Required permission: Market:read 97 # 98 # Store restrictions apply. 99 : Market 100 101 # Required permission: Order:read 102 # 103 # All elements are always returned 104 : [OrderDocument!]! 105 106 # Required permission: StorePlugin:read 107 # 108 # Store restrictions apply. 109 : StorePlugin 110 111 # Required permission: PaymentHistory:read 112 # 113 # Limit must be in range 1 - 200 114 # 115 # Store restrictions apply. 116 # 117 # Arguments 118 # where: (self-explanatory) 119 # sort: (self-explanatory) 120 # limit: (self-explanatory) 121 # page: (self-explanatory) 122 (: PaymentHistoryEntryFilter, : [PaymentHistoryEntrySort!] = [id_DESC], : Int = 20, : Int = 1): [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 : [WholesaleReturn!]! 135 136 # Required permission: Shipment:read 137 # 138 # All elements are always returned 139 # 140 # Store restrictions apply. 141 : [WholesaleShipment!]! 142 143 # Required permission: Order.shippingAddress:read 144 : Address 145 146 # Required permission: ShippingOption:read 147 : ShippingPriceGroup 148 149 # Required permission: none 150 : CountryState 151 152 # Required permission: Store:read 153 # 154 # Store restrictions apply. 155 : Store! 156 157 # Required permission: Order:read 158 : OrderTotals! 159 160 # All elements are always returned 161 : [TaxBreakdownLine!]! 162 163 # Required permission: AllocationRule:read 164 : AllocationRule 165 166 : BuyerInfo! 167 168 : Boolean! 169 170 : Boolean! 171 172 : Boolean! 173 174 : Boolean! 175 176 : Boolean! 177 178 : Boolean! 179 180 : Boolean! 181 182 # Arguments 183 # includeWaitingForConfirmation: (self-explanatory) 184 (: Boolean! = true): Int! 185 186 : String 187 188 : String 189 190 # Required permission: Account:read 191 # 192 # Store restrictions apply. 193 : Account 194 195 # Required permission: Buyer:read 196 # 197 # Store restrictions apply. 198 : Buyer 199 200 # Required permission: Commission:read 201 # 202 # All elements are always returned 203 : [Commission!]! 204 205 # Required permission: DeliveryWindow:read 206 # 207 # Limit must be in range 1 - 200 208 # 209 # Store restrictions apply. 210 # 211 # Arguments 212 # where: (self-explanatory) 213 # sort: (self-explanatory) 214 # limit: (self-explanatory) 215 # page: (self-explanatory) 216 (: DeliveryWindowFilter, : [DeliveryWindowSort!] = [id_ASC], : Int = 20, : Int = 1): [DeliveryWindow!]! 217 218 # Required permission: ShippingTerms:read 219 # 220 # Store restrictions apply. 221 : ShippingTerms 222 223 # Required permission: PaymentTerms:read 224 # 225 # Store restrictions apply. 226 : PaymentTerms 227 228 # Required permission: Order:read 229 # 230 # All elements are always returned 231 : [OrderAttachment!]! 232 233 # Arguments 234 # format: ISO-8601 235 (: String = "Y-m-d\\TH:i:sP"): DateTimeTz 236 237 # Arguments 238 # format: ISO-8601 239 (: String = "Y-m-d\\TH:i:sP"): DateTimeTz 240 241 # A note on an order if the Account doesn't want the order after a certain date. 242 # The order is not automatically cancelled on the Cancel Date, it is a note for sales staff. 243 # It's not a date when the order is actually canceled. 244 # 245 # Arguments 246 # format: ISO-8601 247 (: String = "Y-m-d\\TH:i:sP"): DateTimeTz 248 249 # Required permission: Account:read 250 : AddressBookEntry 251 252 }