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. Production access (all methods) requires the order manager role. Sandbox access does not.

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.



3647
3648
3649
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3647

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) 


3521
3522
3523
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3521

def acknowledged
  @acknowledged
end

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

The billing address. Corresponds to the JSON property billingAddress

Returns:



3527
3528
3529
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3527

def billing_address
  @billing_address
end

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

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

Returns:



3532
3533
3534
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3532

def customer
  @customer
end

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

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

Returns:



3537
3538
3539
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3537

def delivery_details
  @delivery_details
end

#id ⇒ String

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

Returns:

  • (String) 


3542
3543
3544
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3542

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) 


3548
3549
3550
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3548

def kind
  @kind
end

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

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

Returns:



3553
3554
3555
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3553

def line_items
  @line_items
end

#merchant_id ⇒ Fixnum

Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


3558
3559
3560
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3558

def merchant_id
  @merchant_id
end

#merchant_order_id ⇒ String

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

Returns:

  • (String) 


3563
3564
3565
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3563

def merchant_order_id
  @merchant_order_id
end

#net_price_amount ⇒ Google::Apis::ContentV2_1::Price

The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $ 80. Corresponds to the JSON property netPriceAmount

Returns:



3570
3571
3572
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3570

def net_price_amount
  @net_price_amount
end

#net_tax_amount ⇒ Google::Apis::ContentV2_1::Price

The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment netTaxAmount might not match to a sum of tax field across all lineItems and refunds. Corresponds to the JSON property netTaxAmount

Returns:



3577
3578
3579
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3577

def net_tax_amount
  @net_tax_amount
end

#payment_status ⇒ String

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

Returns:

  • (String) 


3582
3583
3584
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3582

def payment_status
  @payment_status
end

#pickup_details ⇒ Google::Apis::ContentV2_1::OrderPickupDetails

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

Returns:



3587
3588
3589
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3587

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) 


3592
3593
3594
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3592

def placed_date
  @placed_date
end

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

Promotions associated with the order. To determine which promotions apply to which products, check the Promotions[]. appliedItems[].lineItemId field against the LineItems[].id 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:

  • To calculate price paid by the customer for a single line item including the discount: For each promotion, subtract the LineItems[].adjustments[]. priceAdjustment.value amount from the LineItems[].Price.value.
  • To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide the LineItems[].adjustments[].priceAdjustment.value by the quantity of products then subtract the resulting value from the 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:



3615
3616
3617
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3615

def promotions
  @promotions
end

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

Refunds for the order. Corresponds to the JSON property refunds

Returns:



3620
3621
3622
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3620

def refunds
  @refunds
end

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

Shipments of the order. Corresponds to the JSON property shipments

Returns:



3625
3626
3627
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3625

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:



3630
3631
3632
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3630

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:



3635
3636
3637
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3635

def shipping_cost_tax
  @shipping_cost_tax
end

#status ⇒ String

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

Returns:

  • (String) 


3640
3641
3642
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3640

def status
  @status
end

#tax_collector ⇒ String

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

Returns:

  • (String) 


3645
3646
3647
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3645

def tax_collector
  @tax_collector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3652

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