Class: Google::Apis::ContentV2_1::Order

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

Overview

Order. All methods require the order manager role.

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



3517
3518
3519
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3517

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) 


3411
3412
3413
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3411

def acknowledged
  @acknowledged
end

#billing_address ⇒ Google::Apis::ContentV2_1::OrderAddress

The billing address. Corresponds to the JSON property billingAddress

Returns:



3417
3418
3419
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3417

def billing_address
  @billing_address
end

#channel_type ⇒ String

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

Returns:

  • (String) 


3422
3423
3424
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3422

def channel_type
  @channel_type
end

#customer ⇒ Google::Apis::ContentV2_1::OrderCustomer

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

Returns:



3427
3428
3429
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3427

def customer
  @customer
end

#delivery_details ⇒ Google::Apis::ContentV2_1::OrderDeliveryDetails

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

Returns:



3432
3433
3434
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3432

def delivery_details
  @delivery_details
end

#id ⇒ String

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

Returns:

  • (String) 


3437
3438
3439
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3437

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) 


3443
3444
3445
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3443

def kind
  @kind
end

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

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

Returns:



3448
3449
3450
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3448

def line_items
  @line_items
end

#merchant_id ⇒ Fixnum

Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


3453
3454
3455
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3453

def merchant_id
  @merchant_id
end

#merchant_order_id ⇒ String

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

Returns:

  • (String) 


3458
3459
3460
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3458

def merchant_order_id
  @merchant_order_id
end

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



3465
3466
3467
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3465

def net_amount
  @net_amount
end

#payment_status ⇒ String

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

Returns:

  • (String) 


3470
3471
3472
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3470

def payment_status
  @payment_status
end

#placed_date ⇒ String

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

Returns:

  • (String) 


3475
3476
3477
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3475

def placed_date
  @placed_date
end

#promotions ⇒ Array<Google::Apis::ContentV2_1::OrderPromotion>

Promotions associated with the order. Corresponds to the JSON property promotions

Returns:



3480
3481
3482
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3480

def promotions
  @promotions
end

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

Refunds for the order. Corresponds to the JSON property refunds

Returns:



3485
3486
3487
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3485

def refunds
  @refunds
end

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

Shipments of the order. Corresponds to the JSON property shipments

Returns:



3490
3491
3492
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3490

def shipments
  @shipments
end

#shipping_cost ⇒ Google::Apis::ContentV2_1::Price

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

Returns:



3495
3496
3497
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3495

def shipping_cost
  @shipping_cost
end

#shipping_cost_tax ⇒ Google::Apis::ContentV2_1::Price

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

Returns:



3500
3501
3502
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3500

def shipping_cost_tax
  @shipping_cost_tax
end

#shipping_option ⇒ String

The requested shipping option. Corresponds to the JSON property shippingOption

Returns:

  • (String) 


3505
3506
3507
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3505

def shipping_option
  @shipping_option
end

#status ⇒ String

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

Returns:

  • (String) 


3510
3511
3512
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3510

def status
  @status
end

#tax_collector ⇒ String

The party responsible for collecting and remitting taxes. Corresponds to the JSON property taxCollector

Returns:

  • (String) 


3515
3516
3517
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3515

def tax_collector
  @tax_collector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3522

def update!(**args)
  @acknowledged = args[:acknowledged] if args.key?(:acknowledged)
  @billing_address = args[:billing_address] if args.key?(:billing_address)
  @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_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)
  @tax_collector = args[:tax_collector] if args.key?(:tax_collector)
end