Struct google_content2::api::OrderMethods
source · pub struct OrderMethods<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
A builder providing access to all methods supported on order resources.
It is not used directly, but through the ShoppingContent
hub.
§Example
Instantiate a resource builder
extern crate hyper;
extern crate hyper_rustls;
extern crate google_content2 as content2;
use std::default::Default;
use content2::{ShoppingContent, oauth2, hyper, hyper_rustls, chrono, FieldMask};
let secret: oauth2::ApplicationSecret = Default::default();
let auth = oauth2::InstalledFlowAuthenticator::builder(
secret,
oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();
let mut hub = ShoppingContent::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `acknowledge(...)`, `advancetestorder(...)`, `cancel(...)`, `cancellineitem(...)`, `canceltestorderbycustomer(...)`, `createtestorder(...)`, `createtestreturn(...)`, `custombatch(...)`, `get(...)`, `getbymerchantorderid(...)`, `gettestordertemplate(...)`, `instorerefundlineitem(...)`, `list(...)`, `refund(...)`, `rejectreturnlineitem(...)`, `returnlineitem(...)`, `returnrefundlineitem(...)`, `setlineitemmetadata(...)`, `shiplineitems(...)`, `updatelineitemshippingdetails(...)`, `updatemerchantorderid(...)` and `updateshipment(...)`
// to build up your call.
let rb = hub.orders();
Implementations§
source§impl<'a, S> OrderMethods<'a, S>
impl<'a, S> OrderMethods<'a, S>
sourcepub fn acknowledge(
&self,
request: OrdersAcknowledgeRequest,
merchant_id: u64,
order_id: &str
) -> OrderAcknowledgeCall<'a, S>
pub fn acknowledge( &self, request: OrdersAcknowledgeRequest, merchant_id: u64, order_id: &str ) -> OrderAcknowledgeCall<'a, S>
Create a builder to help you perform the following task:
Marks an order as acknowledged.
§Arguments
request
- No description provided.merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.
sourcepub fn advancetestorder(
&self,
merchant_id: u64,
order_id: &str
) -> OrderAdvancetestorderCall<'a, S>
pub fn advancetestorder( &self, merchant_id: u64, order_id: &str ) -> OrderAdvancetestorderCall<'a, S>
Create a builder to help you perform the following task:
Sandbox only. Moves a test order from state “inProgress
” to state “pendingShipment
”.
§Arguments
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.
sourcepub fn cancel(
&self,
request: OrdersCancelRequest,
merchant_id: u64,
order_id: &str
) -> OrderCancelCall<'a, S>
pub fn cancel( &self, request: OrdersCancelRequest, merchant_id: u64, order_id: &str ) -> OrderCancelCall<'a, S>
Create a builder to help you perform the following task:
Cancels all line items in an order, making a full refund.
§Arguments
request
- No description provided.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.
sourcepub fn cancellineitem(
&self,
request: OrdersCancelLineItemRequest,
merchant_id: u64,
order_id: &str
) -> OrderCancellineitemCall<'a, S>
pub fn cancellineitem( &self, request: OrdersCancelLineItemRequest, merchant_id: u64, order_id: &str ) -> OrderCancellineitemCall<'a, S>
Create a builder to help you perform the following task:
Cancels a line item, making a full refund.
§Arguments
request
- No description provided.merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.
sourcepub fn canceltestorderbycustomer(
&self,
request: OrdersCancelTestOrderByCustomerRequest,
merchant_id: u64,
order_id: &str
) -> OrderCanceltestorderbycustomerCall<'a, S>
pub fn canceltestorderbycustomer( &self, request: OrdersCancelTestOrderByCustomerRequest, merchant_id: u64, order_id: &str ) -> OrderCanceltestorderbycustomerCall<'a, S>
Create a builder to help you perform the following task:
Sandbox only. Cancels a test order for customer-initiated cancellation.
§Arguments
request
- No description provided.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.
sourcepub fn createtestorder(
&self,
request: OrdersCreateTestOrderRequest,
merchant_id: u64
) -> OrderCreatetestorderCall<'a, S>
pub fn createtestorder( &self, request: OrdersCreateTestOrderRequest, merchant_id: u64 ) -> OrderCreatetestorderCall<'a, S>
Create a builder to help you perform the following task:
Sandbox only. Creates a test order.
§Arguments
request
- No description provided.merchantId
- The ID of the account that should manage the order. This cannot be a multi-client account.
sourcepub fn createtestreturn(
&self,
request: OrdersCreateTestReturnRequest,
merchant_id: u64,
order_id: &str
) -> OrderCreatetestreturnCall<'a, S>
pub fn createtestreturn( &self, request: OrdersCreateTestReturnRequest, merchant_id: u64, order_id: &str ) -> OrderCreatetestreturnCall<'a, S>
Create a builder to help you perform the following task:
Sandbox only. Creates a test return.
§Arguments
request
- No description provided.merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.
sourcepub fn custombatch(
&self,
request: OrdersCustomBatchRequest
) -> OrderCustombatchCall<'a, S>
pub fn custombatch( &self, request: OrdersCustomBatchRequest ) -> OrderCustombatchCall<'a, S>
Create a builder to help you perform the following task:
Retrieves or modifies multiple orders in a single request.
§Arguments
request
- No description provided.
sourcepub fn get(&self, merchant_id: u64, order_id: &str) -> OrderGetCall<'a, S>
pub fn get(&self, merchant_id: u64, order_id: &str) -> OrderGetCall<'a, S>
Create a builder to help you perform the following task:
Retrieves an order from your Merchant Center account.
§Arguments
merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.
sourcepub fn getbymerchantorderid(
&self,
merchant_id: u64,
merchant_order_id: &str
) -> OrderGetbymerchantorderidCall<'a, S>
pub fn getbymerchantorderid( &self, merchant_id: u64, merchant_order_id: &str ) -> OrderGetbymerchantorderidCall<'a, S>
Create a builder to help you perform the following task:
Retrieves an order using merchant order ID.
§Arguments
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.
sourcepub fn gettestordertemplate(
&self,
merchant_id: u64,
template_name: &str
) -> OrderGettestordertemplateCall<'a, S>
pub fn gettestordertemplate( &self, merchant_id: u64, template_name: &str ) -> OrderGettestordertemplateCall<'a, S>
Create a builder to help you perform the following task:
Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.
§Arguments
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.
sourcepub fn instorerefundlineitem(
&self,
request: OrdersInStoreRefundLineItemRequest,
merchant_id: u64,
order_id: &str
) -> OrderInstorerefundlineitemCall<'a, S>
pub fn instorerefundlineitem( &self, request: OrdersInStoreRefundLineItemRequest, merchant_id: u64, order_id: &str ) -> OrderInstorerefundlineitemCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.
sourcepub fn list(&self, merchant_id: u64) -> OrderListCall<'a, S>
pub fn list(&self, merchant_id: u64) -> OrderListCall<'a, S>
Create a builder to help you perform the following task:
Lists the orders in your Merchant Center account.
§Arguments
merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.
sourcepub fn refund(
&self,
request: OrdersRefundRequest,
merchant_id: u64,
order_id: &str
) -> OrderRefundCall<'a, S>
pub fn refund( &self, request: OrdersRefundRequest, merchant_id: u64, order_id: &str ) -> OrderRefundCall<'a, S>
Create a builder to help you perform the following task:
Deprecated, please use returnRefundLineItem instead.
§Arguments
request
- No description provided.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.
sourcepub fn rejectreturnlineitem(
&self,
request: OrdersRejectReturnLineItemRequest,
merchant_id: u64,
order_id: &str
) -> OrderRejectreturnlineitemCall<'a, S>
pub fn rejectreturnlineitem( &self, request: OrdersRejectReturnLineItemRequest, merchant_id: u64, order_id: &str ) -> OrderRejectreturnlineitemCall<'a, S>
Create a builder to help you perform the following task:
Rejects return on an line item.
§Arguments
request
- No description provided.merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.
sourcepub fn returnlineitem(
&self,
request: OrdersReturnLineItemRequest,
merchant_id: u64,
order_id: &str
) -> OrderReturnlineitemCall<'a, S>
pub fn returnlineitem( &self, request: OrdersReturnLineItemRequest, merchant_id: u64, order_id: &str ) -> OrderReturnlineitemCall<'a, S>
Create a builder to help you perform the following task:
Returns a line item.
§Arguments
request
- No description provided.merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.
sourcepub fn returnrefundlineitem(
&self,
request: OrdersReturnRefundLineItemRequest,
merchant_id: u64,
order_id: &str
) -> OrderReturnrefundlineitemCall<'a, S>
pub fn returnrefundlineitem( &self, request: OrdersReturnRefundLineItemRequest, merchant_id: u64, order_id: &str ) -> OrderReturnrefundlineitemCall<'a, S>
Create a builder to help you perform the following task:
Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that 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.
§Arguments
request
- No description provided.merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.
sourcepub fn setlineitemmetadata(
&self,
request: OrdersSetLineItemMetadataRequest,
merchant_id: u64,
order_id: &str
) -> OrderSetlineitemmetadataCall<'a, S>
pub fn setlineitemmetadata( &self, request: OrdersSetLineItemMetadataRequest, merchant_id: u64, order_id: &str ) -> OrderSetlineitemmetadataCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.
sourcepub fn shiplineitems(
&self,
request: OrdersShipLineItemsRequest,
merchant_id: u64,
order_id: &str
) -> OrderShiplineitemCall<'a, S>
pub fn shiplineitems( &self, request: OrdersShipLineItemsRequest, merchant_id: u64, order_id: &str ) -> OrderShiplineitemCall<'a, S>
Create a builder to help you perform the following task:
Marks line item(s) as shipped.
§Arguments
request
- No description provided.merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.
sourcepub fn updatelineitemshippingdetails(
&self,
request: OrdersUpdateLineItemShippingDetailsRequest,
merchant_id: u64,
order_id: &str
) -> OrderUpdatelineitemshippingdetailCall<'a, S>
pub fn updatelineitemshippingdetails( &self, request: OrdersUpdateLineItemShippingDetailsRequest, merchant_id: u64, order_id: &str ) -> OrderUpdatelineitemshippingdetailCall<'a, S>
Create a builder to help you perform the following task:
Updates ship by and delivery by dates for a line item.
§Arguments
request
- No description provided.merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.
sourcepub fn updatemerchantorderid(
&self,
request: OrdersUpdateMerchantOrderIdRequest,
merchant_id: u64,
order_id: &str
) -> OrderUpdatemerchantorderidCall<'a, S>
pub fn updatemerchantorderid( &self, request: OrdersUpdateMerchantOrderIdRequest, merchant_id: u64, order_id: &str ) -> OrderUpdatemerchantorderidCall<'a, S>
Create a builder to help you perform the following task:
Updates the merchant order ID for a given order.
§Arguments
request
- No description provided.merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.
sourcepub fn updateshipment(
&self,
request: OrdersUpdateShipmentRequest,
merchant_id: u64,
order_id: &str
) -> OrderUpdateshipmentCall<'a, S>
pub fn updateshipment( &self, request: OrdersUpdateShipmentRequest, merchant_id: u64, order_id: &str ) -> OrderUpdateshipmentCall<'a, S>
Create a builder to help you perform the following task:
Updates a shipment’s status, carrier, and/or tracking ID.
§Arguments
request
- No description provided.merchantId
- The ID of the account that manages the order. This cannot be a multi-client account.orderId
- The ID of the order.