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

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



4280
4281
4282
 
# File 'generated/google/apis/content_v2/classes.rb', line 4280

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) 


4148
4149
4150
 
# File 'generated/google/apis/content_v2/classes.rb', line 4148

def acknowledged
  @acknowledged
end

#channel_type ⇒ String

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

Returns:

  • (String) 


4154
4155
4156
 
# File 'generated/google/apis/content_v2/classes.rb', line 4154

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:



4159
4160
4161
 
# File 'generated/google/apis/content_v2/classes.rb', line 4159

def customer
  @customer
end

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

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

Returns:



4164
4165
4166
 
# File 'generated/google/apis/content_v2/classes.rb', line 4164

def delivery_details
  @delivery_details
end

#id ⇒ String

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

Returns:

  • (String) 


4169
4170
4171
 
# File 'generated/google/apis/content_v2/classes.rb', line 4169

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) 


4175
4176
4177
 
# File 'generated/google/apis/content_v2/classes.rb', line 4175

def kind
  @kind
end

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

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

Returns:



4180
4181
4182
 
# File 'generated/google/apis/content_v2/classes.rb', line 4180

def line_items
  @line_items
end

#merchant_id ⇒ Fixnum

Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


4185
4186
4187
 
# File 'generated/google/apis/content_v2/classes.rb', line 4185

def merchant_id
  @merchant_id
end

#merchant_order_id ⇒ String

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

Returns:

  • (String) 


4190
4191
4192
 
# File 'generated/google/apis/content_v2/classes.rb', line 4190

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:



4197
4198
4199
 
# File 'generated/google/apis/content_v2/classes.rb', line 4197

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:



4202
4203
4204
 
# File 'generated/google/apis/content_v2/classes.rb', line 4202

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) 


4208
4209
4210
 
# File 'generated/google/apis/content_v2/classes.rb', line 4208

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:



4213
4214
4215
 
# File 'generated/google/apis/content_v2/classes.rb', line 4213

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) 


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

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:



4238
4239
4240
 
# File 'generated/google/apis/content_v2/classes.rb', line 4238

def promotions
  @promotions
end

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

Refunds for the order. Corresponds to the JSON property refunds

Returns:



4243
4244
4245
 
# File 'generated/google/apis/content_v2/classes.rb', line 4243

def refunds
  @refunds
end

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

Shipments of the order. Corresponds to the JSON property shipments

Returns:



4248
4249
4250
 
# File 'generated/google/apis/content_v2/classes.rb', line 4248

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:



4253
4254
4255
 
# File 'generated/google/apis/content_v2/classes.rb', line 4253

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:



4258
4259
4260
 
# File 'generated/google/apis/content_v2/classes.rb', line 4258

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) 


4265
4266
4267
 
# File 'generated/google/apis/content_v2/classes.rb', line 4265

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) 


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

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) 


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

def tax_collector
  @tax_collector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
 
# File 'generated/google/apis/content_v2/classes.rb', line 4285

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