Tradera.com API Documentation - [WebService] RestrictedService

Services that require authorization from the Tradera user being impersonated.

The following operations are supported. For a formal definition, please review the Service Description.

AddCampaign
Adds a campaign for the calling user's shop. All campaigns have a graphical banner, which is
shown at the top of the shop. A campaign can also include a list of items. Clicking on the banner
will bring the user to the items.
Parameters
1. campaignData, Information (see CampaignData ) for the Campaign. The Id element is ignored.
Returns
The id of the created campaign.
AddItem
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
1. 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.
Tutorials
- Adding an Item (Auction)
- Adding an Item (Tradera Direct)
AddItemCommit
Commits the Item-request so that it can be processed into the Tradera system.
Call this method after uploading all images.
Parameters
1. requestId, The reserved Id of an Item request, created with a call to AddItem or AddItemXml
Tutorials
- Adding an Item (Auction)
- Adding an Item (Tradera Direct)
AddItemImage
Uploads an image, and attaches it to a previously created ItemRequest .
Please note that the ItemRequest must be set to AutoCommit == false when AddItem request is made.
Parameters
1. requestId, The request Id of an Item request, created with a call to AddItem or AddItemXml
2. imageData, The image data, including file headers and so on
3. imageFormat, The type/format of image being uploaded
4. hasMega, If the image should have a Mega-image (extra large)
Tutorials
- Adding an Item (Auction)
- Adding an Item (Tradera Direct)

Adds an ItemRequest into the Tradera systems using an XML string. SOAP clients
are encouraged to use the AddItem method instead.

If uploading images, set the AutoCommit AutoCommit to false, call AddItemImage for every image and then
call AddItemCommit after the last image. For more information about the different elements in the Request XML, see the ItemRequest class.

Note that this is an asynchronous call, which means that the item is not added into the Tradera system when this method returns. It is only added
to a queue for processing, see AddItem and AddShopItem for additional information.

Parameters

createItemRequestXml, XML data containing the values for the new Item. XML format:


                    <CreateItemRequest>

                        <AutoCommit>bool</AutoCommit>

                        <ItemType>int</ItemType>

                    					 

                        <Title>string</Title>	

                        <ShippingCondition>string</ShippingCondition>

                        <PaymentCondition>string</PaymentCondition>

                        <CategoryId>int</CategoryId>

                        <Duration>int</Duration>

                        <Restarts>int</Restarts>

                        <StartPrice>int</StartPrice>

                        <ReservePrice>int</ReservePrice>

                        <BuyItNowPrice>int</BuyItNowPrice>

                        <Description>string</Description>

                        <AcceptedBidderId>int</AcceptedBidderId>

                        <VAT>int</VAT>		

                    		 

                        <OwnReferences>

                            <OwnReference>string</OwnReference>

                            <OwnReference>string</OwnReference>

                            <OwnReference>string</OwnReference>

                            <OwnReference>string</OwnReference>

                        </OwnReferences>

                    						

                        <ExpoItemIds>

                            <ExpoItemId>int</ExpoItemId>

                            <ExpoItemId>int</ExpoItemId>

                        </ExpoItemIds>

                    		 

                        <PaymentOptionIds>

                            <PaymentOptionId>int</PaymentOptionId>

                            <PaymentOptionId>int</PaymentOptionId>

                        </PaymentOptionIds>	

                    		

                        <ShippingOptions>

                            <ShippingOption>

                                <Id>int</Id>

                                <Cost>int</Cost>

                            </ShippingOption>

                            <ShippingOption>

                                <Id>int</Id>

                                <Cost>int</Cost>

                            </ShippingOption>

                        </ShippingOptions>	

                    			

                        <ItemAttributes>

                            <ItemAttribute>int</ItemAttribute>

                            <ItemAttribute>int</ItemAttribute>

                        </ItemAttributes>	

                    </CreateItemRequest>

See the ItemRequest class for a description of the parameters.

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.

AddShopItem
This API method is used to create new Shop item on Tradera. This is an asynchronous call which
means that the provided ShopItemData 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
1. shopItemData, Shop item data
Returns
Response data ( QueuedRequestResponse ) with request id and item id. The item id is the id of the new shop 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.
EndItem
Ends an Item immediately if no bids, for shop items use 'RemoveShopItem'
Parameters
1. itemId, The Id of the Item to end
Returns
True if the Item was ended, otherwise false
GetCampaign
Gets information about a campaign.
Parameters
1. campaignId, The id of the campaign to retrieve information about.
Returns
Information about the campaign (see CampaignData ). Only includes the URL to the banner, not the image data.
GetCampaignsList

Gets all the campaigns for the calling user's shop.
Returns
A list of campaigns (see GetCampaignListResponse ).
GetItem
Gets an Item for the current seller.
Parameters
1. itemId, The Id of the Item (auction)
Returns
Item (auction) object
GetItemCampaigns
Gets all the campaigns that an item is included in.
Parameters
1. request, Request object, see GetItemCampaignsRequest object for more information.
Returns
A response object (see GetItemCampaignsResponse ) with a list of campaign ids.
GetItemFees
Gets the fees for an Item.
Parameters
1. itemId, The Id of the item
Returns
Array of Fee objects
GetRequestResults
Retrieves final request results for asynchronous requests like: AddShopItem .
Parameters
1. requestIds, Request ids that are returned from asynchronous requests.
Returns
Array of found RequestResult for every request id that was provided. No request result will be returned for request ids that at the time have no result.
GetSellerItems
Gets items for the current seller.
Parameters
1. categoryId, The Id of the category to look for items in (use 0 for all categories)
2. filterItemType, The filter to use:
  0 = All (max 60 days old items),
  1 = Only active items (EndDate > NOW),
  2 = Only inactive items (EndDate < NOW)
  
  Can be overridden with either the minEndDate or maxEndate parameters.
3. minEndDate, Will return items with EndDate > than this parameter.
  Either send NULL or a DateTime <= DateTime.MinValue (0001-01-01 00:00:00) if not used.
  Note that no items older than 60 days will be returned regardless of minEndDate sent.
4. maxEndDate, Will return items with EndDate < than this parameter.
  Either send NULL or a DateTime >= DateTime.MaxValue (9999-12-31 00:00:00) if not used.
Returns
Array of items
Tutorials
- Using the RestrictedService
GetSellerTransactions
Returns all seller's transactions that have taken place within the specified constraints. The seller in this case is the user for which the call is made for.
Parameters
1. request, Holds request information for this call, see GetSellerTransactionsRequest for detailed information.
Returns
Array of found Transaction objects
GetShopSettings

Returns shop settings owned by the Tradera seller. The seller in this case is the user for which the call is made for.
Returns
Shop settings, see ShopSettingsData
GetUpdatedSellerItems

Returns updated items using criteria properties from request object GetUpdatedSellerItemsRequest . Note that this method retuns only minimal information for the items that are returned.
Returns
The GetUpdatedSellerItemsResponse object that contains updated items.
GetUserInfo

Returns information about the calling user.
Returns
The User object that contains user information.
LeaveFeedback
Leaves feedback for a transaction. If impersonated user is seller,
leaves feedback for the buyer, otherwise leaves feedback for the seller.
Parameters
1. transactionId, The transaction to leave feedback for
2. comment, A freetext comment (80 characters)
3. type, Type of feedback to leave: Positive or Negative
Returns
True if feedback was inserted, false if feedback can not be left for several reasons:
- Transaction does not exist.
- Transaction is older than 60 days.
- Feedback has already been left for the transaction by the requesting user
- Transaction has been deleted by Tradera.
RemoveCampaign
Removes a campaign for the calling user's shop.
Parameters
1. campaignId, The id of the campaign to remove.
RemoveShopItem
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.
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.
SetActivateDateOnShopItems

Sets the activate date on a list of shop items.
SetPriceOnShopItems
Sets the price on a list of shop items.
Parameters
1. request, The list of shop items.
SetQuantityOnShopItems
Sets the quantity on a list of shop items.
Parameters
1. request, The list of shop items.
SetShopSettings
Sets settings of the shop owned by the Tradera seller. The seller in this case is the user for which the call is made for.
Parameters
1. shopSettings, Shop settings that can be set, see ShopSettingsData .
UpdateCampaign
Updates information about a campaign for the calling user's shop.
Parameters
1. campaignData, Update information (see CampaignData ) for the Campaign.
UpdateItemCampaigns
Replaces the list of campaigns that an item is included in.
Parameters
1. itemCampaignsData, Request object, see ItemCampaignsData object for more information.
UpdateShopItem
This API method updates a Shop item. This is an asynchronous call, the method GetRequestResults needs to be called to verify that the shop item was successfully updated.

It is important to know that the update operation can return a new item id in the QueuedRequestResponse response. This can occur if the item that you want to update has at least one transaction (has been bought at least once) when you are trying to update properties that are not allowed to be updated if item that has transaction. If the data of those properties that you are updating are different from those on Tradera then the method will return new item id. Therefore you need to verify if the item id returned in the QueuedRequestResponse has changed. If the item id has changed then you have to use that item id for all future operations. The item with the old id will not longer be availiable.

The following properties of a Shop item ( ShopItemData ) can always be updated without leading to new item id:
- Price
- Quantity
- OwnReferences
- ActivateDate
- Deactivate
- ItemImages
- VAT
- CategoryId
- AcceptedBuyerId
- PaymentCondition
- ShippingCondition

Also, remember to always set only those properties of ShopItemData that you want to update. All other properties need to be set to "null" (xsi:nil="true"), so that API will not consider to update them.
Parameters
1. updateData, Update information (see ShopItemUpdateData ) for the Shop item that will be updated. Set only those properties of ShopItemData you want to update and other as null.
Returns
Response data ( QueuedRequestResponse ) with request id and item id. The item id is the id of the shop item that will be updated on tradera 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.
UpdateTransactionStatus
Updates different transaction status flags, like PaidConfirmed, Shipped etc.
Parameters
1. transactionStatusUpdateData, Request object containing the values to update transaction status flags, see TransactionStatusUpdateData for the additional information.
  To avoid updating certain status flag, it has to be null. Note that at least one of the status flags need to be set.
Returns
Returns Transaction object for the updated transaction with latest transaction status flags.
Note that properties Buyer and Item on Transaction object are not relevant for this call and will be null because they are not set .

Tradera Developer Program

RestrictedService