Tradera Developer Program

RestrictedService

Documentation Version 3 > RestrictedService > RemoveShopItem

RemoveShopItem |WebMethod|

Removes Shop item from Tradera system. This is an asynchronous call, the method GetRequestResults needs to be called to verify that the shop item was successfully removed.
What this method actually does is to set the DeactivateDate to the current time. Another way of making the item not appear in searches and browsing is to set its quantity to 0.
Another way to hide ShopItems from users is to set their quantity to 0 using SetQuantityOnShopItems . This can be done for many items at once.
N.B. Do not use this method for an item that has an ActivateDate (StartDate) that is in the future.

Parameters
  1. shopItemId, The id of Shop item to be removed.
Returns

Response data ( QueuedRequestResponse ) with request id and item id. The item id is the id of the item that was sent in to be removed from Tradera system. The request id
is the identifier of the current request and is used together with API metthod GetRequestResults to get final result of this call.

Code Example

The Following PHP5 example shows how this method can be used to remove a shop item.

  1:
  2:
  3:
  4:
  5:
  6:
  7:
  8:
  9:
 10:
 11:
 12:
 13:
 14:
 15:
 16:
 17:
 18:
 19:
 20:
 21:
 22:
 23:
 24:
 25:
 26:
 27:
 28:
 29:
 30:
 31:
 32:
 33:
 34:
 35:
 36:
 37:
 38:
 39:
 40:
 41:
 42:
 43:
 44:
 45:

// Replace the following variables with your own key management
// $APPLICATION_KEY
// $TOKEN
// $USER_ID
// $APPLICATION_ID
try {
	$appId = $APPLICATION_ID;
	$userId = $USER_ID;
	$token = $TOKEN;
	$appKey = $APPLICATION_KEY;
	$restrictedServiceUrl = 'https://api.tradera.com/v3/RestrictedService.asmx';
	$restrictedServiceUrlWithAuth = $restrictedServiceUrl
					. '?appId=' . $appId
					. '&appKey=' . $appKey
					. '&userId=' . $userId
					. '&token=' . $token;
	$restrictedClient = new SoapClient(
		$restrictedServiceUrl . '?WSDL',
		array('location' => $restrictedServiceUrlWithAuth)
	);
	// The data needed for the request
	$itemToRemove = 260560552; // Tradera item id
	$removeShopItemParams = new StdClass();
	$removeShopItemParams -> shopItemId = $itemToRemove;
	// Make Soap call
	$removeShopItemResult = $restrictedClient->RemoveShopItem($removeShopItemParams);
	// Use the requestId  to verify the request has been succesful
	$requestId = $removeShopItemResult -> RemoveShopItemResult ->  RequestId;
	sleep(5);
	$getReqResultsParams = new StdClass();
	$getReqResultsParams -> requestIds = new StdClass();
	$getReqResultsParams -> requestIds -> int = array($requestId);
	$requestResult = $restrictedClient -> GetRequestResults($getReqResultsParams);
	$result = $requestResult -> GetRequestResultsResult -> RequestResult;
	if($result -> ResultCode == 'Ok'){
		echo 'SUCCES:' . PHP_EOL . $result -> Message . PHP_EOL;
	}
	else {
		echo 'REQUEST NOT FINISHED:' . $result -> ResultCode . PHP_EOL;
		echo $result -> Message;
	}
}
catch(SoapFault $soapFault) {
	echo 'Error: ' . $soapFault->faultstring;
}

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v3/RestrictedService.asmx HTTP/1.1
Host: api.tradera.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.tradera.com/RemoveShopItem"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="http://api.tradera.com">
      <AppId>int</AppId>
      <AppKey>string</AppKey>
    </AuthenticationHeader>
    <AuthorizationHeader xmlns="http://api.tradera.com">
      <UserId>int</UserId>
      <Token>string</Token>
    </AuthorizationHeader>
    <ConfigurationHeader xmlns="http://api.tradera.com">
      <Sandbox>int</Sandbox>
      <MaxResultAge>int</MaxResultAge>
    </ConfigurationHeader>
  </soap:Header>
  <soap:Body>
    <RemoveShopItem xmlns="http://api.tradera.com">
      <shopItemId>int</shopItemId>
    </RemoveShopItem>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RemoveShopItemResponse xmlns="http://api.tradera.com">
      <RemoveShopItemResult>
        <RequestId>int</RequestId>
        <ItemId>int</ItemId>
      </RemoveShopItemResult>
    </RemoveShopItemResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v3/RestrictedService.asmx HTTP/1.1
Host: api.tradera.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthenticationHeader xmlns="http://api.tradera.com">
      <AppId>int</AppId>
      <AppKey>string</AppKey>
    </AuthenticationHeader>
    <AuthorizationHeader xmlns="http://api.tradera.com">
      <UserId>int</UserId>
      <Token>string</Token>
    </AuthorizationHeader>
    <ConfigurationHeader xmlns="http://api.tradera.com">
      <Sandbox>int</Sandbox>
      <MaxResultAge>int</MaxResultAge>
    </ConfigurationHeader>
  </soap12:Header>
  <soap12:Body>
    <RemoveShopItem xmlns="http://api.tradera.com">
      <shopItemId>int</shopItemId>
    </RemoveShopItem>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RemoveShopItemResponse xmlns="http://api.tradera.com">
      <RemoveShopItemResult>
        <RequestId>int</RequestId>
        <ItemId>int</ItemId>
      </RemoveShopItemResult>
    </RemoveShopItemResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /v3/RestrictedService.asmx/RemoveShopItem?shopItemId=string HTTP/1.1
Host: api.tradera.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<QueuedRequestResponse xmlns="http://api.tradera.com">
  <RequestId>int</RequestId>
  <ItemId>int</ItemId>
</QueuedRequestResponse>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /v3/RestrictedService.asmx/RemoveShopItem HTTP/1.1
Host: api.tradera.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

shopItemId=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<QueuedRequestResponse xmlns="http://api.tradera.com">
  <RequestId>int</RequestId>
  <ItemId>int</ItemId>
</QueuedRequestResponse>

XHTML CSS