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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/content_v2_1/classes.rb,
lib/google/apis/content_v2_1/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ Order

Returns a new instance of Order.



5232
5233
5234
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5232

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) 


5100
5101
5102
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5100

def acknowledged
  @acknowledged
end

#annotations ⇒ Array<Google::Apis::ContentV2_1::OrderOrderAnnotation>

List of key-value pairs that are attached to a given order. Corresponds to the JSON property annotations

Returns:



5106
5107
5108
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5106

def annotations
  @annotations
end

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

The billing address. Corresponds to the JSON property billingAddress

Returns:



5111
5112
5113
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5111

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:



5116
5117
5118
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5116

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:



5121
5122
5123
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5121

def delivery_details
  @delivery_details
end

#id ⇒ String

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

Returns:

  • (String) 


5126
5127
5128
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5126

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) 


5132
5133
5134
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5132

def kind
  @kind
end

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

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

Returns:



5137
5138
5139
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5137

def line_items
  @line_items
end

#merchant_id ⇒ Fixnum

Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


5142
5143
5144
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5142

def merchant_id
  @merchant_id
end

#merchant_order_id ⇒ String

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

Returns:

  • (String) 


5147
5148
5149
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5147

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:



5154
5155
5156
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5154

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:



5161
5162
5163
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5161

def net_tax_amount
  @net_tax_amount
end

#payment_status ⇒ String

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

Returns:

  • (String) 


5167
5168
5169
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5167

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:



5172
5173
5174
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5172

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) 


5177
5178
5179
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5177

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: 1. 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.

  1. 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:



5197
5198
5199
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5197

def promotions
  @promotions
end

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

Refunds for the order. Corresponds to the JSON property refunds

Returns:



5202
5203
5204
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5202

def refunds
  @refunds
end

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

Shipments of the order. Corresponds to the JSON property shipments

Returns:



5207
5208
5209
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5207

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:



5212
5213
5214
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5212

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:



5217
5218
5219
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5217

def shipping_cost_tax
  @shipping_cost_tax
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) 


5224
5225
5226
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5224

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) 


5230
5231
5232
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5230

def tax_collector
  @tax_collector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5237

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