Tradera.com API Documentation - [WebService] RestrictedService

AddItem |WebMethod|

This API method is used to create new items (for different item types see GetItemTypes API method) on Tradera,
but not shop items (see AddShopItem for adding shop items). If uploading images set the property AutoCommit to false,
call AddItemImage for every image and then call AddItemCommit after the last image.

Note that this is an asynchronous call which means that the provided data will go through a first step validation
and then be added to a processing queue. The method will then return. The item will be processed as soon as possible depending on the current
system load. To be certain that the item was successfully added on Tradera the method GetRequestResults needs
to be called to verify the final result of the request (see RequestResult ).

Parameters

itemRequest, Object containing the values for the new Item, see ItemRequest

Returns

Response data ( QueuedRequestResponse ) with request id and item id. The item id is the id of
the new item on Tradera. 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

A PHP example showing how AddItem can be used.

  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:
 46:
 47:
 48:
 49:
 50:
 51:
 52:
 53:
 54:
 55:
 56:
 57:
 58:
 59:
 60:
 61:
 62:
 63:
 64:
 65:
 66:
 67:
 68:
 69:
 70:
 71:
 72:
 73:
 74:
 75:
 76:
 77:
 78:
 79:
 80:
 81:
 82:
 83:
 84:
 85:
 86:
 87:
 88:
 89:
 90:
 91:
 92:
 93:
 94:
 95:
 96:
 97:

 // Replace tho following variables with your own key management
 // $APPLICATION_ID
 // $APPLICATION_KEY
 // $USER_ID
 // $TOKEN
 try {
 	$appId = $APPLICATION_ID;
 	$appKey = $APPLICATION_KEY;
 	$userId = $USER_ID;
 	$token = $TOKEN;

 	$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)
 	);

 	$addItemParams = new StdClass();

 	$itemRequest = new StdClass();
 	$itemRequest -> Title = 'Test auction';
 	$itemRequest -> OwnReferences = 'abc123';
 	$itemRequest -> CategoryId = 344481;
 	$itemRequest -> Duration = 4;
 	$itemRequest -> Restarts = 0;
 	$itemRequest -> StartPrice = 1;
 	$itemRequest -> ReservePrice = 0;
 	$itemRequest -> BuyItNowPrice = 0;
 	$itemRequest -> Description = 'A longer description of the test auction item';
 	$itemRequest -> PaymentOptionIds = new StdClass();
 	$itemRequest -> PaymentOptionIds -> int = array(4,32,4096);

 	$shippingOption1 = new StdClass();
 	$shippingOption1 -> ShippingOptionId = 1;
 	$shippingOption1 -> Cost = 7;
 	$shippingOption2 = new StdClass();
 	$shippingOption2 -> ShippingOptionId = 8;
 	$shippingOption2 -> Cost = 0;

 	$itemRequest -> ShippingOptions = new StdClass();
 	$itemRequest -> ShippingOptions -> ItemShipping = array($shippingOption1, $shippingOption2);
 	$itemRequest -> AcceptedBidderId = 1;
 	$itemRequest -> ExpoItemIds = new StdClass();
 	$itemRequest -> ExpoItemIds -> int = array();
 	$itemRequest -> ItemAttributes = new StdClass();
 	$itemRequest -> ItemAttributes -> int = array(2);
 	$itemRequest -> ItemType = 1;
 	$itemRequest -> AutoCommit = false;
 	$itemRequest -> VAT = 0;

 	$addItemParams -> itemRequest = $itemRequest;

 	$addItemResult = $restrictedClient->AddItem($addItemParams);
 	$requestId = $addItemResult -> AddItemResult -> RequestId;


 	$imageFilePath = 'images/image123.jpeg';
 	$imgData =  file_get_contents($imageFilePath);

 	$addImageParams = new StdClass();
 	$addImageParams -> requestId = $requestId;
 	$addImageParams -> imageData = $imgData;
 	$addImageParams -> imageFormat = 'Jpeg';
 	$addImageParams -> hasMega = true;

 	$addItemImageResult = $restrictedClient -> addItemImage($addImageParams);

 	$commitItemParams = new StdClass();
 	$commitItemParams -> requestId = $requestId;
 	$commitItemResult = $restrictedClient->AddItemCommit($commitItemParams);

 	sleep(5);
 	$getReqResultsParams = 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/AddItem"

<?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>
    <AddItem xmlns="http://api.tradera.com">
      <itemRequest>
        <Title>string</Title>
        <OwnReferences>
          <string>string</string>
          <string>string</string>
        </OwnReferences>
        <CategoryId>int</CategoryId>
        <Duration>int</Duration>
        <Restarts>int</Restarts>
        <StartPrice>int</StartPrice>
        <ReservePrice>int</ReservePrice>
        <BuyItNowPrice>int</BuyItNowPrice>
        <Description>string</Description>
        <PaymentOptionIds>
          <int>int</int>
          <int>int</int>
        </PaymentOptionIds>
        <ShippingOptions>
          <ItemShipping>
            <ShippingOptionId>int</ShippingOptionId>
            <Cost>int</Cost>
            <ShippingWeight>decimal</ShippingWeight>
            <ShippingProductId>int</ShippingProductId>
            <ShippingProviderId>int</ShippingProviderId>
          </ItemShipping>
          <ItemShipping>
            <ShippingOptionId>int</ShippingOptionId>
            <Cost>int</Cost>
            <ShippingWeight>decimal</ShippingWeight>
            <ShippingProductId>int</ShippingProductId>
            <ShippingProviderId>int</ShippingProviderId>
          </ItemShipping>
        </ShippingOptions>
        <AcceptedBidderId>int</AcceptedBidderId>
        <ExpoItemIds>
          <int>int</int>
          <int>int</int>
        </ExpoItemIds>
        <CustomEndDate>dateTime</CustomEndDate>
        <ItemAttributes>
          <int>int</int>
          <int>int</int>
        </ItemAttributes>
        <ItemType>int</ItemType>
        <AutoCommit>boolean</AutoCommit>
        <VAT>int</VAT>
        <ShippingCondition>string</ShippingCondition>
        <PaymentCondition>string</PaymentCondition>
        <CampaignCode>string</CampaignCode>
        <DescriptionLanguageCodeIso2>string</DescriptionLanguageCodeIso2>
        <AttributeValues>
          <Terms>
            <TermValues>
              <Id>int</Id>
              <Values>
                <string>string</string>
                <string>string</string>
              </Values>
            </TermValues>
            <TermValues>
              <Id>int</Id>
              <Values>
                <string>string</string>
                <string>string</string>
              </Values>
            </TermValues>
          </Terms>
          <Numbers>
            <NumberValues>
              <Id>int</Id>
              <Values>
                <decimal>decimal</decimal>
                <decimal>decimal</decimal>
              </Values>
            </NumberValues>
            <NumberValues>
              <Id>int</Id>
              <Values>
                <decimal>decimal</decimal>
                <decimal>decimal</decimal>
              </Values>
            </NumberValues>
          </Numbers>
        </AttributeValues>
      </itemRequest>
    </AddItem>
  </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>
    <AddItemResponse xmlns="http://api.tradera.com">
      <AddItemResult>
        <RequestId>int</RequestId>
        <ItemId>int</ItemId>
      </AddItemResult>
    </AddItemResponse>
  </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>
    <AddItem xmlns="http://api.tradera.com">
      <itemRequest>
        <Title>string</Title>
        <OwnReferences>
          <string>string</string>
          <string>string</string>
        </OwnReferences>
        <CategoryId>int</CategoryId>
        <Duration>int</Duration>
        <Restarts>int</Restarts>
        <StartPrice>int</StartPrice>
        <ReservePrice>int</ReservePrice>
        <BuyItNowPrice>int</BuyItNowPrice>
        <Description>string</Description>
        <PaymentOptionIds>
          <int>int</int>
          <int>int</int>
        </PaymentOptionIds>
        <ShippingOptions>
          <ItemShipping>
            <ShippingOptionId>int</ShippingOptionId>
            <Cost>int</Cost>
            <ShippingWeight>decimal</ShippingWeight>
            <ShippingProductId>int</ShippingProductId>
            <ShippingProviderId>int</ShippingProviderId>
          </ItemShipping>
          <ItemShipping>
            <ShippingOptionId>int</ShippingOptionId>
            <Cost>int</Cost>
            <ShippingWeight>decimal</ShippingWeight>
            <ShippingProductId>int</ShippingProductId>
            <ShippingProviderId>int</ShippingProviderId>
          </ItemShipping>
        </ShippingOptions>
        <AcceptedBidderId>int</AcceptedBidderId>
        <ExpoItemIds>
          <int>int</int>
          <int>int</int>
        </ExpoItemIds>
        <CustomEndDate>dateTime</CustomEndDate>
        <ItemAttributes>
          <int>int</int>
          <int>int</int>
        </ItemAttributes>
        <ItemType>int</ItemType>
        <AutoCommit>boolean</AutoCommit>
        <VAT>int</VAT>
        <ShippingCondition>string</ShippingCondition>
        <PaymentCondition>string</PaymentCondition>
        <CampaignCode>string</CampaignCode>
        <DescriptionLanguageCodeIso2>string</DescriptionLanguageCodeIso2>
        <AttributeValues>
          <Terms>
            <TermValues>
              <Id>int</Id>
              <Values>
                <string>string</string>
                <string>string</string>
              </Values>
            </TermValues>
            <TermValues>
              <Id>int</Id>
              <Values>
                <string>string</string>
                <string>string</string>
              </Values>
            </TermValues>
          </Terms>
          <Numbers>
            <NumberValues>
              <Id>int</Id>
              <Values>
                <decimal>decimal</decimal>
                <decimal>decimal</decimal>
              </Values>
            </NumberValues>
            <NumberValues>
              <Id>int</Id>
              <Values>
                <decimal>decimal</decimal>
                <decimal>decimal</decimal>
              </Values>
            </NumberValues>
          </Numbers>
        </AttributeValues>
      </itemRequest>
    </AddItem>
  </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>
    <AddItemResponse xmlns="http://api.tradera.com">
      <AddItemResult>
        <RequestId>int</RequestId>
        <ItemId>int</ItemId>
      </AddItemResult>
    </AddItemResponse>
  </soap12:Body>
</soap12:Envelope>

Tradera Developer Program

RestrictedService

AddItem |WebMethod|

Code Example

SOAP 1.1

SOAP 1.2