Methods summary
public
Google_Service_ShoppingContent_OrdersAcknowledgeResponse
|
#
acknowledge( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersAcknowledgeRequest $postBody, array $optParams = array() )
Marks an order as acknowledged. (orders.acknowledge)
Marks an order as acknowledged. (orders.acknowledge)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $orderId
- The ID of the order.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersAdvanceTestOrderResponse
|
#
advancetestorder( string $merchantId, string $orderId, array $optParams = array() )
Sandbox only. Moves a test order from state "inProgress" to state
"pendingShipment". (orders.advancetestorder)
Sandbox only. Moves a test order from state "inProgress" to state
"pendingShipment". (orders.advancetestorder)
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.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersCancelResponse
|
#
cancel( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersCancelRequest $postBody, array $optParams = array() )
Cancels all line items in an order, making a full refund. (orders.cancel)
Cancels all line items in an order, making a full refund. (orders.cancel)
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.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersCancelLineItemResponse
|
#
cancellineitem( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersCancelLineItemRequest $postBody, array $optParams = array() )
Cancels a line item, making a full refund. (orders.cancellineitem)
Cancels a line item, making a full refund. (orders.cancellineitem)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $orderId
- The ID of the order.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersCancelTestOrderByCustomerResponse
|
#
canceltestorderbycustomer( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersCancelTestOrderByCustomerRequest $postBody, array $optParams = array() )
Sandbox only. Cancels a test order for customer-initiated cancellation.
(orders.canceltestorderbycustomer)
Sandbox only. Cancels a test order for customer-initiated cancellation.
(orders.canceltestorderbycustomer)
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.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersCreateTestOrderResponse
|
#
createtestorder( string $merchantId, Google_Service_ShoppingContent_OrdersCreateTestOrderRequest $postBody, array $optParams = array() )
Sandbox only. Creates a test order. (orders.createtestorder)
Sandbox only. Creates a test order. (orders.createtestorder)
Parameters
- $merchantId
- The ID of the account that should manage the order. This cannot be a
multi-client account.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersCreateTestReturnResponse
|
#
createtestreturn( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersCreateTestReturnRequest $postBody, array $optParams = array() )
Sandbox only. Creates a test return. (orders.createtestreturn)
Sandbox only. Creates a test return. (orders.createtestreturn)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $orderId
- The ID of the order.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_Order
|
#
get( string $merchantId, string $orderId, array $optParams = array() )
Retrieves an order from your Merchant Center account. (orders.get)
Retrieves an order from your Merchant Center account. (orders.get)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $orderId
- The ID of the order.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersGetByMerchantOrderIdResponse
|
#
getbymerchantorderid( string $merchantId, string $merchantOrderId, array $optParams = array() )
Retrieves an order using merchant order ID. (orders.getbymerchantorderid)
Retrieves an order using merchant order ID. (orders.getbymerchantorderid)
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.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersGetTestOrderTemplateResponse
|
#
gettestordertemplate( string $merchantId, string $templateName, array $optParams = array() )
Sandbox only. Retrieves an order template that can be used to quickly create
a new order in sandbox. (orders.gettestordertemplate)
Sandbox only. Retrieves an order template that can be used to quickly create
a new order in sandbox. (orders.gettestordertemplate)
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.
- $optParams
- Optional parameters.
Returns
Opt_param
string country The country of the template to retrieve. Defaults to US.
|
public
Google_Service_ShoppingContent_OrdersInStoreRefundLineItemResponse
|
#
instorerefundlineitem( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersInStoreRefundLineItemRequest $postBody, array $optParams = array() )
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.
(orders.instorerefundlineitem)
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.
(orders.instorerefundlineitem)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $orderId
- The ID of the order.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersListResponse
|
#
listOrders( string $merchantId, array $optParams = array() )
Lists the orders in your Merchant Center account. (orders.listOrders)
Lists the orders in your Merchant Center account. (orders.listOrders)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $optParams
- Optional parameters.
Returns
Opt_param
bool acknowledged Obtains orders that match the acknowledgement status. When set
to true, obtains orders that have been acknowledged. When false, obtains orders
that have not been acknowledged. We recommend using this filter set to false, in
conjunction with the acknowledge call, such that only un-acknowledged orders are
returned.
string maxResults The maximum number of orders to return in the response, used
for paging. The default value is 25 orders per page, and the maximum allowed
value is 250 orders per page.
string orderBy Order results by placement date in descending or ascending order.
Acceptable values are: - placedDateAsc - placedDateDesc
string pageToken The token returned by the previous request.
string placedDateEnd Obtains orders placed before this date (exclusively), in
ISO 8601 format.
string placedDateStart Obtains orders placed after this date (inclusively), in
ISO 8601 format.
string statuses Obtains orders that match any of the specified statuses. Please
note that active is a shortcut for pendingShipment and partiallyShipped, and
completed is a shortcut for shipped, partiallyDelivered, delivered,
partiallyReturned, returned, and canceled.
|
public
Google_Service_ShoppingContent_OrdersRejectReturnLineItemResponse
|
#
rejectreturnlineitem( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersRejectReturnLineItemRequest $postBody, array $optParams = array() )
Rejects return on an line item. (orders.rejectreturnlineitem)
Rejects return on an line item. (orders.rejectreturnlineitem)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $orderId
- The ID of the order.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersReturnRefundLineItemResponse
|
#
returnrefundlineitem( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersReturnRefundLineItemRequest $postBody, array $optParams = array() )
Returns and refunds a line item. Note that this method can only be called on
fully shipped orders. (orders.returnrefundlineitem)
Returns and refunds a line item. Note that this method can only be called on
fully shipped orders. (orders.returnrefundlineitem)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $orderId
- The ID of the order.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersSetLineItemMetadataResponse
|
#
setlineitemmetadata( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersSetLineItemMetadataRequest $postBody, array $optParams = array() )
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. (orders.setlineitemmetadata)
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. (orders.setlineitemmetadata)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $orderId
- The ID of the order.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersShipLineItemsResponse
|
#
shiplineitems( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersShipLineItemsRequest $postBody, array $optParams = array() )
Marks line item(s) as shipped. (orders.shiplineitems)
Marks line item(s) as shipped. (orders.shiplineitems)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $orderId
- The ID of the order.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersUpdateLineItemShippingDetailsResponse
|
#
updatelineitemshippingdetails( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersUpdateLineItemShippingDetailsRequest $postBody, array $optParams = array() )
Updates ship by and delivery by dates for a line item.
(orders.updatelineitemshippingdetails)
Updates ship by and delivery by dates for a line item.
(orders.updatelineitemshippingdetails)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $orderId
- The ID of the order.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersUpdateMerchantOrderIdResponse
|
#
updatemerchantorderid( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersUpdateMerchantOrderIdRequest $postBody, array $optParams = array() )
Updates the merchant order ID for a given order.
(orders.updatemerchantorderid)
Updates the merchant order ID for a given order.
(orders.updatemerchantorderid)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $orderId
- The ID of the order.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_ShoppingContent_OrdersUpdateShipmentResponse
|
#
updateshipment( string $merchantId, string $orderId, Google_Service_ShoppingContent_OrdersUpdateShipmentRequest $postBody, array $optParams = array() )
Updates a shipment's status, carrier, and/or tracking ID.
(orders.updateshipment)
Updates a shipment's status, carrier, and/or tracking ID.
(orders.updateshipment)
Parameters
- $merchantId
- The ID of the account that manages the order. This cannot be a multi-client
account.
- $orderId
- The ID of the order.
- $postBody
- $optParams
- Optional parameters.
Returns
|
Google_Service_ShoppingContent_Orders_Resource