Class: Google::Apis::ContentV2sandbox::Order

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/content_v2sandbox/classes.rb,
generated/google/apis/content_v2sandbox/representations.rb,
generated/google/apis/content_v2sandbox/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Order

Returns a new instance of Order



303
304
305
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 303

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#acknowledgedBoolean Also known as: acknowledged?

Whether the order was acknowledged. Corresponds to the JSON property acknowledged

Returns:

  • (Boolean)


201
202
203
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 201

def acknowledged
  @acknowledged
end

#channel_typeString

The channel type of the order: "purchaseOnGoogle" or "googleExpress". Corresponds to the JSON property channelType

Returns:

  • (String)


207
208
209
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 207

def channel_type
  @channel_type
end

#customerGoogle::Apis::ContentV2sandbox::OrderCustomer

The details of the customer who placed the order. Corresponds to the JSON property customer



212
213
214
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 212

def customer
  @customer
end

#delivery_detailsGoogle::Apis::ContentV2sandbox::OrderDeliveryDetails

The details for the delivery. Corresponds to the JSON property deliveryDetails



217
218
219
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 217

def delivery_details
  @delivery_details
end

#idString

The REST id of the order. Globally unique. Corresponds to the JSON property id

Returns:

  • (String)


222
223
224
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 222

def id
  @id
end

#kindString

Identifies what kind of resource this is. Value: the fixed string "content# order". Corresponds to the JSON property kind

Returns:

  • (String)


228
229
230
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 228

def kind
  @kind
end

#line_itemsArray<Google::Apis::ContentV2sandbox::OrderLineItem>

Line items that are ordered. Corresponds to the JSON property lineItems



233
234
235
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 233

def line_items
  @line_items
end

#merchant_idFixnum

Corresponds to the JSON property merchantId

Returns:

  • (Fixnum)


238
239
240
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 238

def merchant_id
  @merchant_id
end

#merchant_order_idString

Merchant-provided id of the order. Corresponds to the JSON property merchantOrderId

Returns:

  • (String)


243
244
245
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 243

def merchant_order_id
  @merchant_order_id
end

#net_amountGoogle::Apis::ContentV2sandbox::Price

The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $ 80. Corresponds to the JSON property netAmount



250
251
252
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 250

def net_amount
  @net_amount
end

#payment_methodGoogle::Apis::ContentV2sandbox::OrderPaymentMethod

The details of the payment method. Corresponds to the JSON property paymentMethod



255
256
257
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 255

def payment_method
  @payment_method
end

#payment_statusString

The status of the payment. Corresponds to the JSON property paymentStatus

Returns:

  • (String)


260
261
262
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 260

def payment_status
  @payment_status
end

#placed_dateString

The date when the order was placed, in ISO 8601 format. Corresponds to the JSON property placedDate

Returns:

  • (String)


265
266
267
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 265

def placed_date
  @placed_date
end

#promotionsArray<Google::Apis::ContentV2sandbox::OrderPromotion>

The details of the merchant provided promotions applied to the order. More details about the program are here. Corresponds to the JSON property promotions



271
272
273
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 271

def promotions
  @promotions
end

#refundsArray<Google::Apis::ContentV2sandbox::OrderRefund>

Refunds for the order. Corresponds to the JSON property refunds



276
277
278
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 276

def refunds
  @refunds
end

#shipmentsArray<Google::Apis::ContentV2sandbox::OrderShipment>

Shipments of the order. Corresponds to the JSON property shipments



281
282
283
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 281

def shipments
  @shipments
end

#shipping_costGoogle::Apis::ContentV2sandbox::Price

The total cost of shipping for all items. Corresponds to the JSON property shippingCost



286
287
288
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 286

def shipping_cost
  @shipping_cost
end

#shipping_cost_taxGoogle::Apis::ContentV2sandbox::Price

The tax for the total shipping cost. Corresponds to the JSON property shippingCostTax



291
292
293
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 291

def shipping_cost_tax
  @shipping_cost_tax
end

#shipping_optionString

The requested shipping option. Corresponds to the JSON property shippingOption

Returns:

  • (String)


296
297
298
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 296

def shipping_option
  @shipping_option
end

#statusString

The status of the order. Corresponds to the JSON property status

Returns:

  • (String)


301
302
303
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 301

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# File 'generated/google/apis/content_v2sandbox/classes.rb', line 308

def update!(**args)
  @acknowledged = args[:acknowledged] if args.key?(:acknowledged)
  @channel_type = args[:channel_type] if args.key?(:channel_type)
  @customer = args[:customer] if args.key?(:customer)
  @delivery_details = args[:delivery_details] if args.key?(:delivery_details)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @line_items = args[:line_items] if args.key?(:line_items)
  @merchant_id = args[:merchant_id] if args.key?(:merchant_id)
  @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id)
  @net_amount = args[:net_amount] if args.key?(:net_amount)
  @payment_method = args[:payment_method] if args.key?(:payment_method)
  @payment_status = args[:payment_status] if args.key?(:payment_status)
  @placed_date = args[:placed_date] if args.key?(:placed_date)
  @promotions = args[:promotions] if args.key?(:promotions)
  @refunds = args[:refunds] if args.key?(:refunds)
  @shipments = args[:shipments] if args.key?(:shipments)
  @shipping_cost = args[:shipping_cost] if args.key?(:shipping_cost)
  @shipping_cost_tax = args[:shipping_cost_tax] if args.key?(:shipping_cost_tax)
  @shipping_option = args[:shipping_option] if args.key?(:shipping_option)
  @status = args[:status] if args.key?(:status)
end