target.apidocs.com.google.api.services.content.model.Order.html Maven / Gradle / Ivy
Order (Content API for Shopping v2-rev20190308-1.26.0)
com.google.api.services.content.model
Class Order
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.content.model.Order
-
public final class Order
extends com.google.api.client.json.GenericJson
Order. All methods require the order manager role.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation
see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Order()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Order
clone()
Boolean
getAcknowledged()
Whether the order was acknowledged.
String
getChannelType()
Deprecated.
OrderCustomer
getCustomer()
The details of the customer who placed the order.
OrderDeliveryDetails
getDeliveryDetails()
The details for the delivery.
String
getId()
The REST ID of the order.
String
getKind()
Identifies what kind of resource this is.
List<OrderLineItem>
getLineItems()
Line items that are ordered.
BigInteger
getMerchantId()
String
getMerchantOrderId()
Merchant-provided ID of the order.
Price
getNetAmount()
The net amount for the order.
OrderPaymentMethod
getPaymentMethod()
The details of the payment method.
String
getPaymentStatus()
The status of the payment.
String
getPlacedDate()
The date when the order was placed, in ISO 8601 format.
List<OrderLegacyPromotion>
getPromotions()
The details of the merchant provided promotions applied to the order.
List<OrderRefund>
getRefunds()
Refunds for the order.
List<OrderShipment>
getShipments()
Shipments of the order.
Price
getShippingCost()
The total cost of shipping for all items.
Price
getShippingCostTax()
The tax for the total shipping cost.
String
getShippingOption()
Deprecated.
String
getStatus()
The status of the order.
String
getTaxCollector()
The party responsible for collecting and remitting taxes.
Order
set(String fieldName,
Object value)
Order
setAcknowledged(Boolean acknowledged)
Whether the order was acknowledged.
Order
setChannelType(String channelType)
Deprecated.
Order
setCustomer(OrderCustomer customer)
The details of the customer who placed the order.
Order
setDeliveryDetails(OrderDeliveryDetails deliveryDetails)
The details for the delivery.
Order
setId(String id)
The REST ID of the order.
Order
setKind(String kind)
Identifies what kind of resource this is.
Order
setLineItems(List<OrderLineItem> lineItems)
Line items that are ordered.
Order
setMerchantId(BigInteger merchantId)
Order
setMerchantOrderId(String merchantOrderId)
Merchant-provided ID of the order.
Order
setNetAmount(Price netAmount)
The net amount for the order.
Order
setPaymentMethod(OrderPaymentMethod paymentMethod)
The details of the payment method.
Order
setPaymentStatus(String paymentStatus)
The status of the payment.
Order
setPlacedDate(String placedDate)
The date when the order was placed, in ISO 8601 format.
Order
setPromotions(List<OrderLegacyPromotion> promotions)
The details of the merchant provided promotions applied to the order.
Order
setRefunds(List<OrderRefund> refunds)
Refunds for the order.
Order
setShipments(List<OrderShipment> shipments)
Shipments of the order.
Order
setShippingCost(Price shippingCost)
The total cost of shipping for all items.
Order
setShippingCostTax(Price shippingCostTax)
The tax for the total shipping cost.
Order
setShippingOption(String shippingOption)
Deprecated.
Order
setStatus(String status)
The status of the order.
Order
setTaxCollector(String taxCollector)
The party responsible for collecting and remitting taxes.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getAcknowledged
public Boolean getAcknowledged()
Whether the order was acknowledged.
- Returns:
- value or
null
for none
-
setAcknowledged
public Order setAcknowledged(Boolean acknowledged)
Whether the order was acknowledged.
- Parameters:
acknowledged
- acknowledged or null
for none
-
getChannelType
public String getChannelType()
Deprecated.
- Returns:
- value or
null
for none
-
setChannelType
public Order setChannelType(String channelType)
Deprecated.
- Parameters:
channelType
- channelType or null
for none
-
getCustomer
public OrderCustomer getCustomer()
The details of the customer who placed the order.
- Returns:
- value or
null
for none
-
setCustomer
public Order setCustomer(OrderCustomer customer)
The details of the customer who placed the order.
- Parameters:
customer
- customer or null
for none
-
getDeliveryDetails
public OrderDeliveryDetails getDeliveryDetails()
The details for the delivery.
- Returns:
- value or
null
for none
-
setDeliveryDetails
public Order setDeliveryDetails(OrderDeliveryDetails deliveryDetails)
The details for the delivery.
- Parameters:
deliveryDetails
- deliveryDetails or null
for none
-
getId
public String getId()
The REST ID of the order. Globally unique.
- Returns:
- value or
null
for none
-
setId
public Order setId(String id)
The REST ID of the order. Globally unique.
- Parameters:
id
- id or null
for none
-
getKind
public String getKind()
Identifies what kind of resource this is. Value: the fixed string "content#order".
- Returns:
- value or
null
for none
-
setKind
public Order setKind(String kind)
Identifies what kind of resource this is. Value: the fixed string "content#order".
- Parameters:
kind
- kind or null
for none
-
getLineItems
public List<OrderLineItem> getLineItems()
Line items that are ordered.
- Returns:
- value or
null
for none
-
setLineItems
public Order setLineItems(List<OrderLineItem> lineItems)
Line items that are ordered.
- Parameters:
lineItems
- lineItems or null
for none
-
getMerchantId
public BigInteger getMerchantId()
- Returns:
- value or
null
for none
-
setMerchantId
public Order setMerchantId(BigInteger merchantId)
- Parameters:
merchantId
- merchantId or null
for none
-
getMerchantOrderId
public String getMerchantOrderId()
Merchant-provided ID of the order.
- Returns:
- value or
null
for none
-
setMerchantOrderId
public Order setMerchantOrderId(String merchantOrderId)
Merchant-provided ID of the order.
- Parameters:
merchantOrderId
- merchantOrderId or null
for none
-
getNetAmount
public Price getNetAmount()
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.
- Returns:
- value or
null
for none
-
setNetAmount
public Order setNetAmount(Price netAmount)
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.
- Parameters:
netAmount
- netAmount or null
for none
-
getPaymentMethod
public OrderPaymentMethod getPaymentMethod()
The details of the payment method.
- Returns:
- value or
null
for none
-
setPaymentMethod
public Order setPaymentMethod(OrderPaymentMethod paymentMethod)
The details of the payment method.
- Parameters:
paymentMethod
- paymentMethod or null
for none
-
getPaymentStatus
public String getPaymentStatus()
The status of the payment.
- Returns:
- value or
null
for none
-
setPaymentStatus
public Order setPaymentStatus(String paymentStatus)
The status of the payment.
- Parameters:
paymentStatus
- paymentStatus or null
for none
-
getPlacedDate
public String getPlacedDate()
The date when the order was placed, in ISO 8601 format.
- Returns:
- value or
null
for none
-
setPlacedDate
public Order setPlacedDate(String placedDate)
The date when the order was placed, in ISO 8601 format.
- Parameters:
placedDate
- placedDate or null
for none
-
getPromotions
public List<OrderLegacyPromotion> getPromotions()
The details of the merchant provided promotions applied to the order. More details about the
program are here.
- Returns:
- value or
null
for none
-
setPromotions
public Order setPromotions(List<OrderLegacyPromotion> promotions)
The details of the merchant provided promotions applied to the order. More details about the
program are here.
- Parameters:
promotions
- promotions or null
for none
-
getRefunds
public List<OrderRefund> getRefunds()
Refunds for the order.
- Returns:
- value or
null
for none
-
setRefunds
public Order setRefunds(List<OrderRefund> refunds)
Refunds for the order.
- Parameters:
refunds
- refunds or null
for none
-
getShipments
public List<OrderShipment> getShipments()
Shipments of the order.
- Returns:
- value or
null
for none
-
setShipments
public Order setShipments(List<OrderShipment> shipments)
Shipments of the order.
- Parameters:
shipments
- shipments or null
for none
-
getShippingCost
public Price getShippingCost()
The total cost of shipping for all items.
- Returns:
- value or
null
for none
-
setShippingCost
public Order setShippingCost(Price shippingCost)
The total cost of shipping for all items.
- Parameters:
shippingCost
- shippingCost or null
for none
-
getShippingCostTax
public Price getShippingCostTax()
The tax for the total shipping cost.
- Returns:
- value or
null
for none
-
setShippingCostTax
public Order setShippingCostTax(Price shippingCostTax)
The tax for the total shipping cost.
- Parameters:
shippingCostTax
- shippingCostTax or null
for none
-
getShippingOption
public String getShippingOption()
Deprecated. Shipping details are provided with line items instead.
- Returns:
- value or
null
for none
-
setShippingOption
public Order setShippingOption(String shippingOption)
Deprecated. Shipping details are provided with line items instead.
- Parameters:
shippingOption
- shippingOption or null
for none
-
getStatus
public String getStatus()
The status of the order.
- Returns:
- value or
null
for none
-
setStatus
public Order setStatus(String status)
The status of the order.
- Parameters:
status
- status or null
for none
-
getTaxCollector
public String getTaxCollector()
The party responsible for collecting and remitting taxes.
- Returns:
- value or
null
for none
-
setTaxCollector
public Order setTaxCollector(String taxCollector)
The party responsible for collecting and remitting taxes.
- Parameters:
taxCollector
- taxCollector or null
for none
-
set
public Order set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public Order clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2019 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy