Documentation

Google_Service_ShoppingContent_Resource_Orderreturns extends Google_Service_Resource
in package

The "orderreturns" collection of methods.

Typical usage is: $contentService = new Google_Service_ShoppingContent(...); $orderreturns = $contentService->orderreturns;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
acknowledge()  : Google_Service_ShoppingContent_OrderreturnsAcknowledgeResponse
Acks an order return in your Merchant Center account.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_ShoppingContent_MerchantOrderReturn
Retrieves an order return from your Merchant Center account.
listOrderreturns()  : Google_Service_ShoppingContent_OrderreturnsListResponse
Lists order returns in your Merchant Center account.
process()  : Google_Service_ShoppingContent_OrderreturnsProcessResponse
Processes return in your Merchant Center account. (orderreturns.process)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

acknowledge()

Acks an order return in your Merchant Center account.

public acknowledge(string $merchantId, string $returnId, Google_Service_ShoppingContent_OrderreturnsAcknowledgeRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_OrderreturnsAcknowledgeResponse

(orderreturns.acknowledge)

Parameters
$merchantId : string

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

$returnId : string

The ID of the return.

$postBody : Google_Service_ShoppingContent_OrderreturnsAcknowledgeRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_ShoppingContent_OrderreturnsAcknowledgeResponse —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

Retrieves an order return from your Merchant Center account.

public get(string $merchantId, string $returnId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_MerchantOrderReturn

(orderreturns.get)

Parameters
$merchantId : string

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

$returnId : string

Merchant order return ID generated by Google.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_ShoppingContent_MerchantOrderReturn —

listOrderreturns()

Lists order returns in your Merchant Center account.

public listOrderreturns(string $merchantId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_OrderreturnsListResponse

(orderreturns.listOrderreturns)

Parameters
$merchantId : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool acknowledged Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged order returns are returned.

opt_param

string createdEndDate Obtains order returns created before this date (inclusively), in ISO 8601 format.

opt_param

string createdStartDate Obtains order returns created after this date (inclusively), in ISO 8601 format.

opt_param

string googleOrderIds Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.

opt_param

string maxResults The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.

opt_param

string orderBy Return the results in the specified order.

opt_param

string pageToken The token returned by the previous request.

opt_param

string shipmentStates Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.

opt_param

string shipmentStatus Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.

opt_param

string shipmentTrackingNumbers Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.

opt_param

string shipmentTypes Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.

Return values
Google_Service_ShoppingContent_OrderreturnsListResponse —

process()

Processes return in your Merchant Center account. (orderreturns.process)

public process(string $merchantId, string $returnId, Google_Service_ShoppingContent_OrderreturnsProcessRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_OrderreturnsProcessResponse
Parameters
$merchantId : string

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

$returnId : string

The ID of the return.

$postBody : Google_Service_ShoppingContent_OrderreturnsProcessRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_ShoppingContent_OrderreturnsProcessResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results