Clear shopping cart contents
Overview
Use this method to completely clear the contents of the shopping cart.
Requirements
This method requires you to set a specific partner using setPartner.
Parameters
| Parameter | Type/Description |
|---|---|
| sessionID | Required (string) |
| Session identifier, which is the output of the Login method. An exception is thrown if the values are incorrect. | |
| productId | Required (integer) |
| Unique product identifier from the 2Checkout system. | |
| pricingListCode | Required (string) |
| The unique identifier of a partner price list. | |
| quantity | Optional (integer) |
|
Defines the amount of product units to be ordered. If no quantity info is provided, the minimum available number of units is included in the order.
If the quantity provided is not available for purchase, such as in the case of volume discounts, en error message is displayed.
When NULL, quantity = 1 is added automatically. |
|
| priceOptions | Optional (StringArray) |
|
Array of price options codes. If no price options info is provided, the default, required pricing options of the product are ordered. These identifiers mark the individual options inside pricing options configuration groups.
Can be NULL. |
Use this method before placeOrder.
Parameters
| Parameter | Type/Description |
|---|---|
| sessionID | Required (string) |
| Session identifier, which is the output of the Login method. An exception is thrown if the values are incorrect |
Response
| Parameter | Type/Description |
|---|---|
| Result | Boolean |
| True or false |
Request
<?php
require ('PATH_TO_AUTH'); // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/02Authentication
require ('PATH_TO_SET_PARTNER'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/Partner/00Set_partner
require ('PATH_TO_ADD_PRODUCT'); // addProduct example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/08Place_an_order/00Add_product_to_cart
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'clearProducts',
'params' => array($sessionID)
);
var_dump (callRPC((Object)$jsonRpcRequest,$host));