Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
The "orders" collection of methods. More...
Public Member Functions | |
acknowledge ($merchantId, $orderId, Google_Service_ShoppingContent_OrdersAcknowledgeRequest $postBody, $optParams=array()) | |
Marks an order as acknowledged. | |
advancetestorder ($merchantId, $orderId, $optParams=array()) | |
Sandbox only. | |
call ($name, $arguments, $expected_class=null) | |
TODO: This function needs simplifying. | |
cancel ($merchantId, $orderId, Google_Service_ShoppingContent_OrdersCancelRequest $postBody, $optParams=array()) | |
Cancels all line items in an order. | |
cancellineitem ($merchantId, $orderId, Google_Service_ShoppingContent_OrdersCancelLineItemRequest $postBody, $optParams=array()) | |
Cancels a line item. | |
createtestorder ($merchantId, Google_Service_ShoppingContent_OrdersCreateTestOrderRequest $postBody, $optParams=array()) | |
Sandbox only. | |
custombatch (Google_Service_ShoppingContent_OrdersCustomBatchRequest $postBody, $optParams=array()) | |
Retrieves or modifies multiple orders in a single request. | |
get ($merchantId, $orderId, $optParams=array()) | |
Retrieves an order from your Merchant Center account. | |
getbymerchantorderid ($merchantId, $merchantOrderId, $optParams=array()) | |
Retrieves an order using merchant order id. | |
gettestordertemplate ($merchantId, $templateName, $optParams=array()) | |
Sandbox only. | |
listOrders ($merchantId, $optParams=array()) | |
Lists the orders in your Merchant Center account. | |
refund ($merchantId, $orderId, Google_Service_ShoppingContent_OrdersRefundRequest $postBody, $optParams=array()) | |
Refund a portion of the order, up to the full amount paid. | |
returnlineitem ($merchantId, $orderId, Google_Service_ShoppingContent_OrdersReturnLineItemRequest $postBody, $optParams=array()) | |
Returns a line item. | |
shiplineitems ($merchantId, $orderId, Google_Service_ShoppingContent_OrdersShipLineItemsRequest $postBody, $optParams=array()) | |
Marks line item(s) as shipped. | |
updatemerchantorderid ($merchantId, $orderId, Google_Service_ShoppingContent_OrdersUpdateMerchantOrderIdRequest $postBody, $optParams=array()) | |
Updates the merchant order ID for a given order. | |
updateshipment ($merchantId, $orderId, Google_Service_ShoppingContent_OrdersUpdateShipmentRequest $postBody, $optParams=array()) | |
Updates a shipment's status, carrier, and/or tracking ID. | |
Protected Member Functions | |
convertToArrayAndStripNulls ($o) | |
The "orders" collection of methods.
Typical usage is: $contentService = new Google_Service_ShoppingContent(...); $orders = $contentService->orders;
Google_Service_ShoppingContent_Orders_Resource::acknowledge | ( | $merchantId, | |
$orderId, | |||
Google_Service_ShoppingContent_OrdersAcknowledgeRequest | $postBody, | ||
$optParams = array() ) |
Marks an order as acknowledged.
(orders.acknowledge)
string | $merchantId | The ID of the managing account. |
string | $orderId | The ID of the order. |
Google_OrdersAcknowledgeRequest | $postBody | |
array | $optParams | Optional parameters. |
Google_Service_ShoppingContent_OrdersAcknowledgeResponse |
Google_Service_ShoppingContent_Orders_Resource::advancetestorder | ( | $merchantId, | |
$orderId, | |||
$optParams = array() ) |
Sandbox only.
Moves a test order from state "inProgress" to state "pendingShipment". (orders.advancetestorder)
string | $merchantId | The ID of the managing account. |
string | $orderId | The ID of the test order to modify. |
array | $optParams | Optional parameters. |
|
inherited |
TODO: This function needs simplifying.
$name | |
$arguments | |
$expected_class | - optional, the expected class name |
Google_Http_Request|expected_class |
Google_Exception |
Google_Service_ShoppingContent_Orders_Resource::cancel | ( | $merchantId, | |
$orderId, | |||
Google_Service_ShoppingContent_OrdersCancelRequest | $postBody, | ||
$optParams = array() ) |
Cancels all line items in an order.
(orders.cancel)
string | $merchantId | The ID of the managing account. |
string | $orderId | The ID of the order to cancel. |
Google_OrdersCancelRequest | $postBody | |
array | $optParams | Optional parameters. |
Google_Service_ShoppingContent_OrdersCancelResponse |
Google_Service_ShoppingContent_Orders_Resource::cancellineitem | ( | $merchantId, | |
$orderId, | |||
Google_Service_ShoppingContent_OrdersCancelLineItemRequest | $postBody, | ||
$optParams = array() ) |
Cancels a line item.
(orders.cancellineitem)
string | $merchantId | The ID of the managing account. |
string | $orderId | The ID of the order. |
Google_OrdersCancelLineItemRequest | $postBody | |
array | $optParams | Optional parameters. |
Google_Service_ShoppingContent_Orders_Resource::createtestorder | ( | $merchantId, | |
Google_Service_ShoppingContent_OrdersCreateTestOrderRequest | $postBody, | ||
$optParams = array() ) |
Sandbox only.
Creates a test order. (orders.createtestorder)
string | $merchantId | The ID of the managing account. |
Google_OrdersCreateTestOrderRequest | $postBody | |
array | $optParams | Optional parameters. |
Google_Service_ShoppingContent_Orders_Resource::custombatch | ( | Google_Service_ShoppingContent_OrdersCustomBatchRequest | $postBody, |
$optParams = array() ) |
Retrieves or modifies multiple orders in a single request.
(orders.custombatch)
Google_OrdersCustomBatchRequest | $postBody | |
array | $optParams | Optional parameters. |
Google_Service_ShoppingContent_OrdersCustomBatchResponse |
Google_Service_ShoppingContent_Orders_Resource::get | ( | $merchantId, | |
$orderId, | |||
$optParams = array() ) |
Retrieves an order from your Merchant Center account.
(orders.get)
string | $merchantId | The ID of the managing account. |
string | $orderId | The ID of the order. |
array | $optParams | Optional parameters. |
Google_Service_ShoppingContent_Order |
Google_Service_ShoppingContent_Orders_Resource::getbymerchantorderid | ( | $merchantId, | |
$merchantOrderId, | |||
$optParams = array() ) |
Retrieves an order using merchant order id.
(orders.getbymerchantorderid)
string | $merchantId | The ID of the managing account. |
string | $merchantOrderId | The merchant order id to be looked for. |
array | $optParams | Optional parameters. |
Google_Service_ShoppingContent_Orders_Resource::gettestordertemplate | ( | $merchantId, | |
$templateName, | |||
$optParams = array() ) |
Sandbox only.
Retrieves an order template that can be used to quickly create a new order in sandbox. (orders.gettestordertemplate)
string | $merchantId | The ID of the managing account. |
string | $templateName | The name of the template to retrieve. |
array | $optParams | Optional parameters. |
Google_Service_ShoppingContent_Orders_Resource::listOrders | ( | $merchantId, | |
$optParams = array() ) |
Lists the orders in your Merchant Center account.
(orders.listOrders)
string | $merchantId | The ID of the managing account. |
array | $optParams | Optional parameters. |
@opt_param string orderBy The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria. @opt_param string placedDateEnd Obtains orders placed before this date (exclusively), in ISO 8601 format. @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. @opt_param 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. Known issue: All List calls will return all Orders without limit regardless of the value of this field. @opt_param string pageToken The token returned by the previous request. @opt_param string placedDateStart Obtains orders placed after this date (inclusively), in ISO 8601 format. @opt_param string statuses Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.
Google_Service_ShoppingContent_OrdersListResponse |
Google_Service_ShoppingContent_Orders_Resource::refund | ( | $merchantId, | |
$orderId, | |||
Google_Service_ShoppingContent_OrdersRefundRequest | $postBody, | ||
$optParams = array() ) |
Refund a portion of the order, up to the full amount paid.
(orders.refund)
string | $merchantId | The ID of the managing account. |
string | $orderId | The ID of the order to refund. |
Google_OrdersRefundRequest | $postBody | |
array | $optParams | Optional parameters. |
Google_Service_ShoppingContent_OrdersRefundResponse |
Google_Service_ShoppingContent_Orders_Resource::returnlineitem | ( | $merchantId, | |
$orderId, | |||
Google_Service_ShoppingContent_OrdersReturnLineItemRequest | $postBody, | ||
$optParams = array() ) |
Returns a line item.
(orders.returnlineitem)
string | $merchantId | The ID of the managing account. |
string | $orderId | The ID of the order. |
Google_OrdersReturnLineItemRequest | $postBody | |
array | $optParams | Optional parameters. |
Google_Service_ShoppingContent_Orders_Resource::shiplineitems | ( | $merchantId, | |
$orderId, | |||
Google_Service_ShoppingContent_OrdersShipLineItemsRequest | $postBody, | ||
$optParams = array() ) |
Marks line item(s) as shipped.
(orders.shiplineitems)
string | $merchantId | The ID of the managing account. |
string | $orderId | The ID of the order. |
Google_OrdersShipLineItemsRequest | $postBody | |
array | $optParams | Optional parameters. |
Google_Service_ShoppingContent_Orders_Resource::updatemerchantorderid | ( | $merchantId, | |
$orderId, | |||
Google_Service_ShoppingContent_OrdersUpdateMerchantOrderIdRequest | $postBody, | ||
$optParams = array() ) |
Updates the merchant order ID for a given order.
(orders.updatemerchantorderid)
string | $merchantId | The ID of the managing account. |
string | $orderId | The ID of the order. |
Google_OrdersUpdateMerchantOrderIdRequest | $postBody | |
array | $optParams | Optional parameters. |
Google_Service_ShoppingContent_Orders_Resource::updateshipment | ( | $merchantId, | |
$orderId, | |||
Google_Service_ShoppingContent_OrdersUpdateShipmentRequest | $postBody, | ||
$optParams = array() ) |
Updates a shipment's status, carrier, and/or tracking ID.
(orders.updateshipment)
string | $merchantId | The ID of the managing account. |
string | $orderId | The ID of the order. |
Google_OrdersUpdateShipmentRequest | $postBody | |
array | $optParams | Optional parameters. |