com.google.api.services.content

Class ShoppingContent.Orders

java.lang.Object

com.google.api.services.content.ShoppingContent.Orders

Enclosing class:

ShoppingContent

public class ShoppingContent.Orders
extends Object

The "orders" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ShoppingContent.Orders.Acknowledge
class	ShoppingContent.Orders.Advancetestorder
class	ShoppingContent.Orders.Cancel
class	ShoppingContent.Orders.Cancellineitem
class	ShoppingContent.Orders.Canceltestorderbycustomer
class	ShoppingContent.Orders.CaptureOrder
class	ShoppingContent.Orders.Createtestorder
class	ShoppingContent.Orders.Createtestreturn
class	ShoppingContent.Orders.Get
class	ShoppingContent.Orders.Getbymerchantorderid
class	ShoppingContent.Orders.Gettestordertemplate
class	ShoppingContent.Orders.Instorerefundlineitem
class	ShoppingContent.Orders.List
class	ShoppingContent.Orders.Refunditem
class	ShoppingContent.Orders.Refundorder
class	ShoppingContent.Orders.Rejectreturnlineitem
class	ShoppingContent.Orders.Returnrefundlineitem
class	ShoppingContent.Orders.Setlineitemmetadata
class	ShoppingContent.Orders.Shiplineitems
class	ShoppingContent.Orders.Updatelineitemshippingdetails
class	ShoppingContent.Orders.Updatemerchantorderid
class	ShoppingContent.Orders.Updateshipment

Constructor Summary

Constructors

Constructor and Description
Orders()

Method Summary

Modifier and Type	Method and Description
ShoppingContent.Orders.Acknowledge	acknowledge(BigInteger merchantId, String orderId, OrdersAcknowledgeRequest content) Marks an order as acknowledged.
ShoppingContent.Orders.Advancetestorder	advancetestorder(BigInteger merchantId, String orderId) Sandbox only.
ShoppingContent.Orders.Cancel	cancel(BigInteger merchantId, String orderId, OrdersCancelRequest content) Cancels all line items in an order, making a full refund.
ShoppingContent.Orders.Cancellineitem	cancellineitem(BigInteger merchantId, String orderId, OrdersCancelLineItemRequest content) Cancels a line item, making a full refund.
ShoppingContent.Orders.Canceltestorderbycustomer	canceltestorderbycustomer(BigInteger merchantId, String orderId, OrdersCancelTestOrderByCustomerRequest content) Sandbox only.
ShoppingContent.Orders.CaptureOrder	captureOrder(Long merchantId, String orderId, CaptureOrderRequest content) Capture funds from the customer for the current order total.
ShoppingContent.Orders.Createtestorder	createtestorder(BigInteger merchantId, OrdersCreateTestOrderRequest content) Sandbox only.
ShoppingContent.Orders.Createtestreturn	createtestreturn(BigInteger merchantId, String orderId, OrdersCreateTestReturnRequest content) Sandbox only.
ShoppingContent.Orders.Get	get(BigInteger merchantId, String orderId) Retrieves an order from your Merchant Center account.
ShoppingContent.Orders.Getbymerchantorderid	getbymerchantorderid(BigInteger merchantId, String merchantOrderId) Retrieves an order using merchant order ID.
ShoppingContent.Orders.Gettestordertemplate	gettestordertemplate(BigInteger merchantId, String templateName) Sandbox only.
ShoppingContent.Orders.Instorerefundlineitem	instorerefundlineitem(BigInteger merchantId, String orderId, OrdersInStoreRefundLineItemRequest content) Deprecated.
ShoppingContent.Orders.List	list(BigInteger merchantId) Lists the orders in your Merchant Center account.
ShoppingContent.Orders.Refunditem	refunditem(BigInteger merchantId, String orderId, OrdersRefundItemRequest content) Issues a partial or total refund for items and shipment.
ShoppingContent.Orders.Refundorder	refundorder(BigInteger merchantId, String orderId, OrdersRefundOrderRequest content) Issues a partial or total refund for an order.
ShoppingContent.Orders.Rejectreturnlineitem	rejectreturnlineitem(BigInteger merchantId, String orderId, OrdersRejectReturnLineItemRequest content) Rejects return on an line item.
ShoppingContent.Orders.Returnrefundlineitem	returnrefundlineitem(BigInteger merchantId, String orderId, OrdersReturnRefundLineItemRequest content) Returns and refunds a line item.
ShoppingContent.Orders.Setlineitemmetadata	setlineitemmetadata(BigInteger merchantId, String orderId, OrdersSetLineItemMetadataRequest content) Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs.
ShoppingContent.Orders.Shiplineitems	shiplineitems(BigInteger merchantId, String orderId, OrdersShipLineItemsRequest content) Marks line item(s) as shipped.
ShoppingContent.Orders.Updatelineitemshippingdetails	updatelineitemshippingdetails(BigInteger merchantId, String orderId, OrdersUpdateLineItemShippingDetailsRequest content) Updates ship by and delivery by dates for a line item.
ShoppingContent.Orders.Updatemerchantorderid	updatemerchantorderid(BigInteger merchantId, String orderId, OrdersUpdateMerchantOrderIdRequest content) Updates the merchant order ID for a given order.
ShoppingContent.Orders.Updateshipment	updateshipment(BigInteger merchantId, String orderId, OrdersUpdateShipmentRequest content) Updates a shipment's status, carrier, and/or tracking ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Orders

public Orders()

Method Detail

acknowledge

public ShoppingContent.Orders.Acknowledge acknowledge(BigInteger merchantId,
                                                      String orderId,
                                                      OrdersAcknowledgeRequest content)
                                               throws IOException

Marks an order as acknowledged. Create a request for the method "orders.acknowledge". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order.

content - the OrdersAcknowledgeRequest

Returns:

the request

Throws:

IOException

advancetestorder

public ShoppingContent.Orders.Advancetestorder advancetestorder(BigInteger merchantId,
                                                                String orderId)
                                                         throws IOException

Sandbox only. Moves a test order from state "`inProgress`" to state "`pendingShipment`". Create a request for the method "orders.advancetestorder". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the test order to modify.

Returns:

the request

Throws:

IOException

cancel

public ShoppingContent.Orders.Cancel cancel(BigInteger merchantId,
                                            String orderId,
                                            OrdersCancelRequest content)
                                     throws IOException

Cancels all line items in an order, making a full refund. Create a request for the method "orders.cancel". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order to cancel.

content - the OrdersCancelRequest

Returns:

the request

Throws:

IOException

cancellineitem

public ShoppingContent.Orders.Cancellineitem cancellineitem(BigInteger merchantId,
                                                            String orderId,
                                                            OrdersCancelLineItemRequest content)
                                                     throws IOException

Cancels a line item, making a full refund. Create a request for the method "orders.cancellineitem". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order.

content - the OrdersCancelLineItemRequest

Returns:

the request

Throws:

IOException

canceltestorderbycustomer

public ShoppingContent.Orders.Canceltestorderbycustomer canceltestorderbycustomer(BigInteger merchantId,
                                                                                  String orderId,
                                                                                  OrdersCancelTestOrderByCustomerRequest content)
                                                                           throws IOException

Sandbox only. Cancels a test order for customer-initiated cancellation. Create a request for the method "orders.canceltestorderbycustomer". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the test order to cancel.

content - the OrdersCancelTestOrderByCustomerRequest

Returns:

the request

Throws:

IOException

captureOrder

public ShoppingContent.Orders.CaptureOrder captureOrder(Long merchantId,
                                                        String orderId,
                                                        CaptureOrderRequest content)
                                                 throws IOException

Capture funds from the customer for the current order total. This method should be called after the merchant verifies that they are able and ready to start shipping the order. This method blocks until a response is received from the payment processsor. If this method succeeds, the merchant is guaranteed to receive funds for the order after shipment. If the request fails, it can be retried or the order may be cancelled. This method cannot be called after the entire order is already shipped. A rejected error code is returned when the payment service provider has declined the charge. This indicates a problem between the PSP and either the merchant's or customer's account. Sometimes this error will be resolved by the customer. We recommend retrying these errors once per day or cancelling the order with reason `failedToCaptureFunds` if the items cannot be held. Create a request for the method "orders.captureOrder". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - Required. The ID of the account that manages the order. This cannot be a multi-client account.

orderId - Required. The ID of the Order.

content - the CaptureOrderRequest

Returns:

the request

Throws:

IOException

createtestorder

public ShoppingContent.Orders.Createtestorder createtestorder(BigInteger merchantId,
                                                              OrdersCreateTestOrderRequest content)
                                                       throws IOException

Sandbox only. Creates a test order. Create a request for the method "orders.createtestorder". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that should manage the order. This cannot be a multi-client account.

content - the OrdersCreateTestOrderRequest

Returns:

the request

Throws:

IOException

createtestreturn

public ShoppingContent.Orders.Createtestreturn createtestreturn(BigInteger merchantId,
                                                                String orderId,
                                                                OrdersCreateTestReturnRequest content)
                                                         throws IOException

Sandbox only. Creates a test return. Create a request for the method "orders.createtestreturn". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order.

content - the OrdersCreateTestReturnRequest

Returns:

the request

Throws:

IOException

get

public ShoppingContent.Orders.Get get(BigInteger merchantId,
                                      String orderId)
                               throws IOException

Retrieves an order from your Merchant Center account. Create a request for the method "orders.get". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order.

Returns:

the request

Throws:

IOException

getbymerchantorderid

public ShoppingContent.Orders.Getbymerchantorderid getbymerchantorderid(BigInteger merchantId,
                                                                        String merchantOrderId)
                                                                 throws IOException

Retrieves an order using merchant order ID. Create a request for the method "orders.getbymerchantorderid". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

merchantOrderId - The merchant order ID to be looked for.

Returns:

the request

Throws:

IOException

gettestordertemplate

public ShoppingContent.Orders.Gettestordertemplate gettestordertemplate(BigInteger merchantId,
                                                                        String templateName)
                                                                 throws IOException

Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. Create a request for the method "orders.gettestordertemplate". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that should manage the order. This cannot be a multi-client account.

templateName - The name of the template to retrieve.

Returns:

the request

Throws:

IOException

instorerefundlineitem

public ShoppingContent.Orders.Instorerefundlineitem instorerefundlineitem(BigInteger merchantId,
                                                                          String orderId,
                                                                          OrdersInStoreRefundLineItemRequest content)
                                                                   throws IOException

Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (for example, cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding through Google then through an in-store return. Create a request for the method "orders.instorerefundlineitem". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order.

content - the OrdersInStoreRefundLineItemRequest

Returns:

the request

Throws:

IOException

list

public ShoppingContent.Orders.List list(BigInteger merchantId)
                                 throws IOException

Lists the orders in your Merchant Center account. Create a request for the method "orders.list". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

Returns:

the request

Throws:

IOException

refunditem

public ShoppingContent.Orders.Refunditem refunditem(BigInteger merchantId,
                                                    String orderId,
                                                    OrdersRefundItemRequest content)
                                             throws IOException

Issues a partial or total refund for items and shipment. Create a request for the method "orders.refunditem". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order to refund.

content - the OrdersRefundItemRequest

Returns:

the request

Throws:

IOException

refundorder

public ShoppingContent.Orders.Refundorder refundorder(BigInteger merchantId,
                                                      String orderId,
                                                      OrdersRefundOrderRequest content)
                                               throws IOException

Issues a partial or total refund for an order. Create a request for the method "orders.refundorder". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order to refund.

content - the OrdersRefundOrderRequest

Returns:

the request

Throws:

IOException

rejectreturnlineitem

public ShoppingContent.Orders.Rejectreturnlineitem rejectreturnlineitem(BigInteger merchantId,
                                                                        String orderId,
                                                                        OrdersRejectReturnLineItemRequest content)
                                                                 throws IOException

Rejects return on an line item. Create a request for the method "orders.rejectreturnlineitem". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order.

content - the OrdersRejectReturnLineItemRequest

Returns:

the request

Throws:

IOException

returnrefundlineitem

public ShoppingContent.Orders.Returnrefundlineitem returnrefundlineitem(BigInteger merchantId,
                                                                        String orderId,
                                                                        OrdersReturnRefundLineItemRequest content)
                                                                 throws IOException

Returns and refunds a line item. Note that this method can only be called on fully shipped orders. The Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund. Create a request for the method "orders.returnrefundlineitem". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order.

content - the OrdersReturnRefundLineItemRequest

Returns:

the request

Throws:

IOException

setlineitemmetadata

public ShoppingContent.Orders.Setlineitemmetadata setlineitemmetadata(BigInteger merchantId,
                                                                      String orderId,
                                                                      OrdersSetLineItemMetadataRequest content)
                                                               throws IOException

Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided through other methods. Submitted key-value pairs can be retrieved as part of the orders resource. Create a request for the method "orders.setlineitemmetadata". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order.

content - the OrdersSetLineItemMetadataRequest

Returns:

the request

Throws:

IOException

shiplineitems

public ShoppingContent.Orders.Shiplineitems shiplineitems(BigInteger merchantId,
                                                          String orderId,
                                                          OrdersShipLineItemsRequest content)
                                                   throws IOException

Marks line item(s) as shipped. Create a request for the method "orders.shiplineitems". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order.

content - the OrdersShipLineItemsRequest

Returns:

the request

Throws:

IOException

updatelineitemshippingdetails

public ShoppingContent.Orders.Updatelineitemshippingdetails updatelineitemshippingdetails(BigInteger merchantId,
                                                                                          String orderId,
                                                                                          OrdersUpdateLineItemShippingDetailsRequest content)
                                                                                   throws IOException

Updates ship by and delivery by dates for a line item. Create a request for the method "orders.updatelineitemshippingdetails". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order.

content - the OrdersUpdateLineItemShippingDetailsRequest

Returns:

the request

Throws:

IOException

updatemerchantorderid

public ShoppingContent.Orders.Updatemerchantorderid updatemerchantorderid(BigInteger merchantId,
                                                                          String orderId,
                                                                          OrdersUpdateMerchantOrderIdRequest content)
                                                                   throws IOException

Updates the merchant order ID for a given order. Create a request for the method "orders.updatemerchantorderid". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order.

content - the OrdersUpdateMerchantOrderIdRequest

Returns:

the request

Throws:

IOException

updateshipment

public ShoppingContent.Orders.Updateshipment updateshipment(BigInteger merchantId,
                                                            String orderId,
                                                            OrdersUpdateShipmentRequest content)
                                                     throws IOException

Updates a shipment's status, carrier, and/or tracking ID. Create a request for the method "orders.updateshipment". This request holds the parameters needed by the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

merchantId - The ID of the account that manages the order. This cannot be a multi-client account.

orderId - The ID of the order.

content - the OrdersUpdateShipmentRequest

Returns:

the request

Throws:

IOException