Class: Google::Apis::ContentV2::Order

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

Overview

Order. Production access (all methods) requires the order manager role. Sandbox access does not.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Order

Returns a new instance of Order.



4350
4351
4352
 
# File 'lib/google/apis/content_v2/classes.rb', line 4350

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

Instance Attribute Details

#acknowledged ⇒ Boolean Also known as: acknowledged?

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

Returns:

  • (Boolean) 


4218
4219
4220
 
# File 'lib/google/apis/content_v2/classes.rb', line 4218

def acknowledged
  @acknowledged
end

#channel_type ⇒ String

Deprecated. Acceptable values are: - "googleExpress" - "purchasesOnGoogle" Corresponds to the JSON property channelType

Returns:

  • (String) 


4224
4225
4226
 
# File 'lib/google/apis/content_v2/classes.rb', line 4224

def channel_type
  @channel_type
end

#customer ⇒ Google::Apis::ContentV2::OrderCustomer

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

Returns:



4229
4230
4231
 
# File 'lib/google/apis/content_v2/classes.rb', line 4229

def customer
  @customer
end

#delivery_details ⇒ Google::Apis::ContentV2::OrderDeliveryDetails

Delivery details for shipments of type delivery. Corresponds to the JSON property deliveryDetails

Returns:



4234
4235
4236
 
# File 'lib/google/apis/content_v2/classes.rb', line 4234

def delivery_details
  @delivery_details
end

#id ⇒ String

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

Returns:

  • (String) 


4239
4240
4241
 
# File 'lib/google/apis/content_v2/classes.rb', line 4239

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


4245
4246
4247
 
# File 'lib/google/apis/content_v2/classes.rb', line 4245

def kind
  @kind
end

#line_items ⇒ Array<Google::Apis::ContentV2::OrderLineItem>

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

Returns:



4250
4251
4252
 
# File 'lib/google/apis/content_v2/classes.rb', line 4250

def line_items
  @line_items
end

#merchant_id ⇒ Fixnum

Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


4255
4256
4257
 
# File 'lib/google/apis/content_v2/classes.rb', line 4255

def merchant_id
  @merchant_id
end

#merchant_order_id ⇒ String

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

Returns:

  • (String) 


4260
4261
4262
 
# File 'lib/google/apis/content_v2/classes.rb', line 4260

def merchant_order_id
  @merchant_order_id
end

#net_amount ⇒ Google::Apis::ContentV2::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

Returns:



4267
4268
4269
 
# File 'lib/google/apis/content_v2/classes.rb', line 4267

def net_amount
  @net_amount
end

#payment_method ⇒ Google::Apis::ContentV2::OrderPaymentMethod

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

Returns:



4272
4273
4274
 
# File 'lib/google/apis/content_v2/classes.rb', line 4272

def payment_method
  @payment_method
end

#payment_status ⇒ String

The status of the payment. Acceptable values are: - "paymentCaptured" - " paymentRejected" - "paymentSecured" - "pendingAuthorization" Corresponds to the JSON property paymentStatus

Returns:

  • (String) 


4278
4279
4280
 
# File 'lib/google/apis/content_v2/classes.rb', line 4278

def payment_status
  @payment_status
end

#pickup_details ⇒ Google::Apis::ContentV2::OrderPickupDetails

Pickup details for shipments of type pickup. Corresponds to the JSON property pickupDetails

Returns:



4283
4284
4285
 
# File 'lib/google/apis/content_v2/classes.rb', line 4283

def pickup_details
  @pickup_details
end

#placed_date ⇒ String

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

Returns:

  • (String) 


4288
4289
4290
 
# File 'lib/google/apis/content_v2/classes.rb', line 4288

def placed_date
  @placed_date
end

#promotions ⇒ Array<Google::Apis::ContentV2::OrderLegacyPromotion>

The details of the merchant provided promotions applied to the order. To determine which promotions apply to which products, check the Promotions[]. Benefits[].OfferIds field against the LineItems[].Product.OfferId field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId. Examples: 1. To calculate the line item level discount for a single specific item: For each promotion, subtract the Promotions[].Benefits[].Discount.value amount from the LineItems[].Price. value. 2. To calculate the line item level discount for multiple quantity of a specific item: For each promotion, divide the Promotions[].Benefits[]. Discount.value by the quantity of products and substract it from LineItems[]. Product.Price.value for each quantity item. Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. More details about the program are here. Corresponds to the JSON property promotions

Returns:



4308
4309
4310
 
# File 'lib/google/apis/content_v2/classes.rb', line 4308

def promotions
  @promotions
end

#refunds ⇒ Array<Google::Apis::ContentV2::OrderRefund>

Refunds for the order. Corresponds to the JSON property refunds

Returns:



4313
4314
4315
 
# File 'lib/google/apis/content_v2/classes.rb', line 4313

def refunds
  @refunds
end

#shipments ⇒ Array<Google::Apis::ContentV2::OrderShipment>

Shipments of the order. Corresponds to the JSON property shipments

Returns:



4318
4319
4320
 
# File 'lib/google/apis/content_v2/classes.rb', line 4318

def shipments
  @shipments
end

#shipping_cost ⇒ Google::Apis::ContentV2::Price

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

Returns:



4323
4324
4325
 
# File 'lib/google/apis/content_v2/classes.rb', line 4323

def shipping_cost
  @shipping_cost
end

#shipping_cost_tax ⇒ Google::Apis::ContentV2::Price

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

Returns:



4328
4329
4330
 
# File 'lib/google/apis/content_v2/classes.rb', line 4328

def shipping_cost_tax
  @shipping_cost_tax
end

#shipping_option ⇒ String

Deprecated. Shipping details are provided with line items instead. Acceptable values are: - "economy" - "expedited" - "oneDay" - "sameDay" - " standard" - "twoDay" Corresponds to the JSON property shippingOption

Returns:

  • (String) 


4335
4336
4337
 
# File 'lib/google/apis/content_v2/classes.rb', line 4335

def shipping_option
  @shipping_option
end

#status ⇒ String

The status of the order. Acceptable values are: - "canceled" - "delivered"

  • "inProgress" - "partiallyDelivered" - "partiallyReturned" - " partiallyShipped" - "pendingShipment" - "returned" - "shipped" Corresponds to the JSON property status

Returns:

  • (String) 


4342
4343
4344
 
# File 'lib/google/apis/content_v2/classes.rb', line 4342

def status
  @status
end

#tax_collector ⇒ String

The party responsible for collecting and remitting taxes. Acceptable values are: - "marketplaceFacilitator" - "merchant" Corresponds to the JSON property taxCollector

Returns:

  • (String) 


4348
4349
4350
 
# File 'lib/google/apis/content_v2/classes.rb', line 4348

def tax_collector
  @tax_collector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
 
# File 'lib/google/apis/content_v2/classes.rb', line 4355

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)
  @pickup_details = args[:pickup_details] if args.key?(:pickup_details)
  @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)
  @tax_collector = args[:tax_collector] if args.key?(:tax_collector)
end