content  v2.1
Classes | Public Member Functions | List of all members
Google.Apis.ShoppingContent.v2_1.OrdersResource Class Reference

The "orders" collection of methods. More...

Classes

class  AcknowledgeRequest
 Marks an order as acknowledged. More...
 
class  AdvancetestorderRequest
 Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment". More...
 
class  CancellineitemRequest
 Cancels a line item, making a full refund. More...
 
class  CancelRequest
 Cancels all line items in an order, making a full refund. More...
 
class  CanceltestorderbycustomerRequest
 Sandbox only. Cancels a test order for customer-initiated cancellation. More...
 
class  CreatetestorderRequest
 Sandbox only. Creates a test order. More...
 
class  CreatetestreturnRequest
 Sandbox only. Creates a test return. More...
 
class  GetbymerchantorderidRequest
 Retrieves an order using merchant order ID. More...
 
class  GetRequest
 Retrieves an order from your Merchant Center account. More...
 
class  GettestordertemplateRequest
 Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. More...
 
class  InstorerefundlineitemRequest
 Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. 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 via Google then via an in-store return. More...
 
class  ListRequest
 Lists the orders in your Merchant Center account. More...
 
class  RejectreturnlineitemRequest
 Rejects return on an line item. More...
 
class  ReturnrefundlineitemRequest
 Returns and refunds a line item. Note that this method can only be called on fully shipped orders. More...
 
class  SetlineitemmetadataRequest
 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 via other methods. Submitted key-value pairs can be retrieved as part of the orders resource. More...
 
class  ShiplineitemsRequest
 Marks line item(s) as shipped. More...
 
class  UpdatelineitemshippingdetailsRequest
 Updates ship by and delivery by dates for a line item. More...
 
class  UpdatemerchantorderidRequest
 Updates the merchant order ID for a given order. More...
 
class  UpdateshipmentRequest
 Updates a shipment's status, carrier, and/or tracking ID. More...
 

Public Member Functions

 OrdersResource (Google.Apis.Services.IClientService service)
 Constructs a new resource. More...
 
virtual AcknowledgeRequest Acknowledge (Google.Apis.ShoppingContent.v2_1.Data.OrdersAcknowledgeRequest body, ulong merchantId, string orderId)
 Marks an order as acknowledged. More...
 
virtual AdvancetestorderRequest Advancetestorder (ulong merchantId, string orderId)
 Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment". More...
 
virtual CancelRequest Cancel (Google.Apis.ShoppingContent.v2_1.Data.OrdersCancelRequest body, ulong merchantId, string orderId)
 Cancels all line items in an order, making a full refund. More...
 
virtual CancellineitemRequest Cancellineitem (Google.Apis.ShoppingContent.v2_1.Data.OrdersCancelLineItemRequest body, ulong merchantId, string orderId)
 Cancels a line item, making a full refund. More...
 
virtual CanceltestorderbycustomerRequest Canceltestorderbycustomer (Google.Apis.ShoppingContent.v2_1.Data.OrdersCancelTestOrderByCustomerRequest body, ulong merchantId, string orderId)
 Sandbox only. Cancels a test order for customer-initiated cancellation. More...
 
virtual CreatetestorderRequest Createtestorder (Google.Apis.ShoppingContent.v2_1.Data.OrdersCreateTestOrderRequest body, ulong merchantId)
 Sandbox only. Creates a test order. More...
 
virtual CreatetestreturnRequest Createtestreturn (Google.Apis.ShoppingContent.v2_1.Data.OrdersCreateTestReturnRequest body, ulong merchantId, string orderId)
 Sandbox only. Creates a test return. More...
 
virtual GetRequest Get (ulong merchantId, string orderId)
 Retrieves an order from your Merchant Center account. More...
 
virtual GetbymerchantorderidRequest Getbymerchantorderid (ulong merchantId, string merchantOrderId)
 Retrieves an order using merchant order ID. More...
 
virtual GettestordertemplateRequest Gettestordertemplate (ulong merchantId, GettestordertemplateRequest.TemplateNameEnum templateName)
 Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. More...
 
virtual InstorerefundlineitemRequest Instorerefundlineitem (Google.Apis.ShoppingContent.v2_1.Data.OrdersInStoreRefundLineItemRequest body, ulong merchantId, string orderId)
 Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. 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 via Google then via an in-store return. More...
 
virtual ListRequest List (ulong merchantId)
 Lists the orders in your Merchant Center account. More...
 
virtual RejectreturnlineitemRequest Rejectreturnlineitem (Google.Apis.ShoppingContent.v2_1.Data.OrdersRejectReturnLineItemRequest body, ulong merchantId, string orderId)
 Rejects return on an line item. More...
 
virtual ReturnrefundlineitemRequest Returnrefundlineitem (Google.Apis.ShoppingContent.v2_1.Data.OrdersReturnRefundLineItemRequest body, ulong merchantId, string orderId)
 Returns and refunds a line item. Note that this method can only be called on fully shipped orders. More...
 
virtual SetlineitemmetadataRequest Setlineitemmetadata (Google.Apis.ShoppingContent.v2_1.Data.OrdersSetLineItemMetadataRequest body, ulong merchantId, string orderId)
 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 via other methods. Submitted key-value pairs can be retrieved as part of the orders resource. More...
 
virtual ShiplineitemsRequest Shiplineitems (Google.Apis.ShoppingContent.v2_1.Data.OrdersShipLineItemsRequest body, ulong merchantId, string orderId)
 Marks line item(s) as shipped. More...
 
virtual UpdatelineitemshippingdetailsRequest Updatelineitemshippingdetails (Google.Apis.ShoppingContent.v2_1.Data.OrdersUpdateLineItemShippingDetailsRequest body, ulong merchantId, string orderId)
 Updates ship by and delivery by dates for a line item. More...
 
virtual UpdatemerchantorderidRequest Updatemerchantorderid (Google.Apis.ShoppingContent.v2_1.Data.OrdersUpdateMerchantOrderIdRequest body, ulong merchantId, string orderId)
 Updates the merchant order ID for a given order. More...
 
virtual UpdateshipmentRequest Updateshipment (Google.Apis.ShoppingContent.v2_1.Data.OrdersUpdateShipmentRequest body, ulong merchantId, string orderId)
 Updates a shipment's status, carrier, and/or tracking ID. More...
 

Detailed Description

The "orders" collection of methods.

Constructor & Destructor Documentation

◆ OrdersResource()

Google.Apis.ShoppingContent.v2_1.OrdersResource.OrdersResource ( Google.Apis.Services.IClientService  service)
inline

Constructs a new resource.

Member Function Documentation

◆ Acknowledge()

virtual AcknowledgeRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Acknowledge ( Google.Apis.ShoppingContent.v2_1.Data.OrdersAcknowledgeRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

Marks an order as acknowledged.

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order.

◆ Advancetestorder()

virtual AdvancetestorderRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Advancetestorder ( ulong  merchantId,
string  orderId 
)
inlinevirtual

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

Parameters
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the test order to modify.

◆ Cancel()

virtual CancelRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Cancel ( Google.Apis.ShoppingContent.v2_1.Data.OrdersCancelRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

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

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order to cancel.

◆ Cancellineitem()

virtual CancellineitemRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Cancellineitem ( Google.Apis.ShoppingContent.v2_1.Data.OrdersCancelLineItemRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

Cancels a line item, making a full refund.

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order.

◆ Canceltestorderbycustomer()

virtual CanceltestorderbycustomerRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Canceltestorderbycustomer ( Google.Apis.ShoppingContent.v2_1.Data.OrdersCancelTestOrderByCustomerRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

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

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the test order to cancel.

◆ Createtestorder()

virtual CreatetestorderRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Createtestorder ( Google.Apis.ShoppingContent.v2_1.Data.OrdersCreateTestOrderRequest  body,
ulong  merchantId 
)
inlinevirtual

Sandbox only. Creates a test order.

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that should manage the order. This cannot be a multi-client account.

◆ Createtestreturn()

virtual CreatetestreturnRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Createtestreturn ( Google.Apis.ShoppingContent.v2_1.Data.OrdersCreateTestReturnRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

Sandbox only. Creates a test return.

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order.

◆ Get()

virtual GetRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Get ( ulong  merchantId,
string  orderId 
)
inlinevirtual

Retrieves an order from your Merchant Center account.

Parameters
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order.

◆ Getbymerchantorderid()

virtual GetbymerchantorderidRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Getbymerchantorderid ( ulong  merchantId,
string  merchantOrderId 
)
inlinevirtual

Retrieves an order using merchant order ID.

Parameters
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
merchantOrderIdThe merchant order ID to be looked for.

◆ Gettestordertemplate()

virtual GettestordertemplateRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Gettestordertemplate ( ulong  merchantId,
GettestordertemplateRequest.TemplateNameEnum  templateName 
)
inlinevirtual

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

Parameters
merchantIdThe ID of the account that should manage the order. This cannot be a multi-client account.
templateNameThe name of the template to retrieve.

◆ Instorerefundlineitem()

virtual InstorerefundlineitemRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Instorerefundlineitem ( Google.Apis.ShoppingContent.v2_1.Data.OrdersInStoreRefundLineItemRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. 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 via Google then via an in-store return.

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order.

◆ List()

virtual ListRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.List ( ulong  merchantId)
inlinevirtual

Lists the orders in your Merchant Center account.

Parameters
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.

◆ Rejectreturnlineitem()

virtual RejectreturnlineitemRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Rejectreturnlineitem ( Google.Apis.ShoppingContent.v2_1.Data.OrdersRejectReturnLineItemRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

Rejects return on an line item.

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order.

◆ Returnrefundlineitem()

virtual ReturnrefundlineitemRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Returnrefundlineitem ( Google.Apis.ShoppingContent.v2_1.Data.OrdersReturnRefundLineItemRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

Returns and refunds a line item. Note that this method can only be called on fully shipped orders.

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order.

◆ Setlineitemmetadata()

virtual SetlineitemmetadataRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Setlineitemmetadata ( Google.Apis.ShoppingContent.v2_1.Data.OrdersSetLineItemMetadataRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

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 via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order.

◆ Shiplineitems()

virtual ShiplineitemsRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Shiplineitems ( Google.Apis.ShoppingContent.v2_1.Data.OrdersShipLineItemsRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

Marks line item(s) as shipped.

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order.

◆ Updatelineitemshippingdetails()

virtual UpdatelineitemshippingdetailsRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Updatelineitemshippingdetails ( Google.Apis.ShoppingContent.v2_1.Data.OrdersUpdateLineItemShippingDetailsRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

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

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order.

◆ Updatemerchantorderid()

virtual UpdatemerchantorderidRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Updatemerchantorderid ( Google.Apis.ShoppingContent.v2_1.Data.OrdersUpdateMerchantOrderIdRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

Updates the merchant order ID for a given order.

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order.

◆ Updateshipment()

virtual UpdateshipmentRequest Google.Apis.ShoppingContent.v2_1.OrdersResource.Updateshipment ( Google.Apis.ShoppingContent.v2_1.Data.OrdersUpdateShipmentRequest  body,
ulong  merchantId,
string  orderId 
)
inlinevirtual

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

Parameters
bodyThe body of the request.
merchantIdThe ID of the account that manages the order. This cannot be a multi-client account.
orderIdThe ID of the order.

The documentation for this class was generated from the following file: