Class OrdersResource

The "orders" collection of methods.

Inheritance

object

OrdersResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.ShoppingContent.v2_1

Assembly: Google.Apis.ShoppingContent.v2_1.dll

Syntax

public class OrdersResource

Constructors

OrdersResource(IClientService)

Constructs a new resource.

Declaration

public OrdersResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Acknowledge(OrdersAcknowledgeRequest, ulong, string)

Marks an order as acknowledged.

Declaration

public virtual OrdersResource.AcknowledgeRequest Acknowledge(OrdersAcknowledgeRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersAcknowledgeRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order.

Returns

Type	Description
OrdersResource.AcknowledgeRequest

Advancetestorder(ulong, string)

Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".

Declaration

public virtual OrdersResource.AdvancetestorderRequest Advancetestorder(ulong merchantId, string orderId)

Parameters

Type	Name	Description
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the test order to modify.

Returns

Type	Description
OrdersResource.AdvancetestorderRequest

Cancel(OrdersCancelRequest, ulong, string)

Cancels all line items in an order, making a full refund.

Declaration

public virtual OrdersResource.CancelRequest Cancel(OrdersCancelRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersCancelRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order to cancel.

Returns

Type	Description
OrdersResource.CancelRequest

Cancellineitem(OrdersCancelLineItemRequest, ulong, string)

Cancels a line item, making a full refund.

Declaration

public virtual OrdersResource.CancellineitemRequest Cancellineitem(OrdersCancelLineItemRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersCancelLineItemRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order.

Returns

Type	Description
OrdersResource.CancellineitemRequest

Canceltestorderbycustomer(OrdersCancelTestOrderByCustomerRequest, ulong, string)

Sandbox only. Cancels a test order for customer-initiated cancellation.

Declaration

public virtual OrdersResource.CanceltestorderbycustomerRequest Canceltestorderbycustomer(OrdersCancelTestOrderByCustomerRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersCancelTestOrderByCustomerRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the test order to cancel.

Returns

Type	Description
OrdersResource.CanceltestorderbycustomerRequest

CaptureOrder(CaptureOrderRequest, long, string)

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.

Declaration

public virtual OrdersResource.CaptureOrderRequest CaptureOrder(CaptureOrderRequest body, long merchantId, string orderId)

Parameters

Type	Name	Description
CaptureOrderRequest	body	The body of the request.
long	merchantId	Required. The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	Required. The ID of the Order.

Returns

Type	Description
OrdersResource.CaptureOrderRequest

Createtestorder(OrdersCreateTestOrderRequest, ulong)

Sandbox only. Creates a test order.

Declaration

public virtual OrdersResource.CreatetestorderRequest Createtestorder(OrdersCreateTestOrderRequest body, ulong merchantId)

Parameters

Type	Name	Description
OrdersCreateTestOrderRequest	body	The body of the request.
ulong	merchantId	The ID of the account that should manage the order. This cannot be a multi-client account.

Returns

Type	Description
OrdersResource.CreatetestorderRequest

Createtestreturn(OrdersCreateTestReturnRequest, ulong, string)

Sandbox only. Creates a test return.

Declaration

public virtual OrdersResource.CreatetestreturnRequest Createtestreturn(OrdersCreateTestReturnRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersCreateTestReturnRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order.

Returns

Type	Description
OrdersResource.CreatetestreturnRequest

Get(ulong, string)

Retrieves an order from your Merchant Center account.

Declaration

public virtual OrdersResource.GetRequest Get(ulong merchantId, string orderId)

Parameters

Type	Name	Description
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order.

Returns

Type	Description
OrdersResource.GetRequest

Getbymerchantorderid(ulong, string)

Retrieves an order using merchant order ID.

Declaration

public virtual OrdersResource.GetbymerchantorderidRequest Getbymerchantorderid(ulong merchantId, string merchantOrderId)

Parameters

Type	Name	Description
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	merchantOrderId	The merchant order ID to be looked for.

Returns

Type	Description
OrdersResource.GetbymerchantorderidRequest

Gettestordertemplate(ulong, TemplateNameEnum)

Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.

Declaration

public virtual OrdersResource.GettestordertemplateRequest Gettestordertemplate(ulong merchantId, OrdersResource.GettestordertemplateRequest.TemplateNameEnum templateName)

Parameters

Type	Name	Description
ulong	merchantId	The ID of the account that should manage the order. This cannot be a multi-client account.
OrdersResource.GettestordertemplateRequest.TemplateNameEnum	templateName	The name of the template to retrieve.

Returns

Type	Description
OrdersResource.GettestordertemplateRequest

Instorerefundlineitem(OrdersInStoreRefundLineItemRequest, ulong, string)

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.

Declaration

public virtual OrdersResource.InstorerefundlineitemRequest Instorerefundlineitem(OrdersInStoreRefundLineItemRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersInStoreRefundLineItemRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order.

Returns

Type	Description
OrdersResource.InstorerefundlineitemRequest

List(ulong)

Lists the orders in your Merchant Center account.

Declaration

public virtual OrdersResource.ListRequest List(ulong merchantId)

Parameters

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

Returns

Type	Description
OrdersResource.ListRequest

Refunditem(OrdersRefundItemRequest, ulong, string)

Issues a partial or total refund for items and shipment.

Declaration

public virtual OrdersResource.RefunditemRequest Refunditem(OrdersRefundItemRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersRefundItemRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order to refund.

Returns

Type	Description
OrdersResource.RefunditemRequest

Refundorder(OrdersRefundOrderRequest, ulong, string)

Issues a partial or total refund for an order.

Declaration

public virtual OrdersResource.RefundorderRequest Refundorder(OrdersRefundOrderRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersRefundOrderRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order to refund.

Returns

Type	Description
OrdersResource.RefundorderRequest

Rejectreturnlineitem(OrdersRejectReturnLineItemRequest, ulong, string)

Rejects return on an line item.

Declaration

public virtual OrdersResource.RejectreturnlineitemRequest Rejectreturnlineitem(OrdersRejectReturnLineItemRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersRejectReturnLineItemRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order.

Returns

Type	Description
OrdersResource.RejectreturnlineitemRequest

Returnrefundlineitem(OrdersReturnRefundLineItemRequest, ulong, string)

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.

Declaration

public virtual OrdersResource.ReturnrefundlineitemRequest Returnrefundlineitem(OrdersReturnRefundLineItemRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersReturnRefundLineItemRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order.

Returns

Type	Description
OrdersResource.ReturnrefundlineitemRequest

Setlineitemmetadata(OrdersSetLineItemMetadataRequest, ulong, string)

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.

Declaration

public virtual OrdersResource.SetlineitemmetadataRequest Setlineitemmetadata(OrdersSetLineItemMetadataRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersSetLineItemMetadataRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order.

Returns

Type	Description
OrdersResource.SetlineitemmetadataRequest

Shiplineitems(OrdersShipLineItemsRequest, ulong, string)

Marks line item(s) as shipped.

Declaration

public virtual OrdersResource.ShiplineitemsRequest Shiplineitems(OrdersShipLineItemsRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersShipLineItemsRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order.

Returns

Type	Description
OrdersResource.ShiplineitemsRequest

Updatelineitemshippingdetails(OrdersUpdateLineItemShippingDetailsRequest, ulong, string)

Updates ship by and delivery by dates for a line item.

Declaration

public virtual OrdersResource.UpdatelineitemshippingdetailsRequest Updatelineitemshippingdetails(OrdersUpdateLineItemShippingDetailsRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersUpdateLineItemShippingDetailsRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order.

Returns

Type	Description
OrdersResource.UpdatelineitemshippingdetailsRequest

Updatemerchantorderid(OrdersUpdateMerchantOrderIdRequest, ulong, string)

Updates the merchant order ID for a given order.

Declaration

public virtual OrdersResource.UpdatemerchantorderidRequest Updatemerchantorderid(OrdersUpdateMerchantOrderIdRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersUpdateMerchantOrderIdRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order.

Returns

Type	Description
OrdersResource.UpdatemerchantorderidRequest

Updateshipment(OrdersUpdateShipmentRequest, ulong, string)

Updates a shipment's status, carrier, and/or tracking ID.

Declaration

public virtual OrdersResource.UpdateshipmentRequest Updateshipment(OrdersUpdateShipmentRequest body, ulong merchantId, string orderId)

Parameters

Type	Name	Description
OrdersUpdateShipmentRequest	body	The body of the request.
ulong	merchantId	The ID of the account that manages the order. This cannot be a multi-client account.
string	orderId	The ID of the order.

Returns

Type	Description
OrdersResource.UpdateshipmentRequest