Tradera Developer Program

Services that require authorization from the Tradera user being impersonated.

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

• 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.

• AddItemCampaignCode

  Attach a campaign code to a previously created ItemRequest .
  Please note that the ItemRequest must be set to AutoCommit == false when AddItem request is made.
  NOTE: This method is considered internal and might be changed at any time without prior notice.

  Parameters

  1. requestId, The request Id of an Item request, created with a call to AddItem or AddItemXml
  2. campaignCode, The campaign code to attach

• 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

• 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. Max accepted size: 4MB
  3. imageFormat, The type/format of image being uploaded
  4. hasMega, If the image should have a Mega-image (extra large)

• AddItemXml

  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

  1. 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. ha

• AddShopItemVariant

  See method AddShopItem

  Parameters

  1. shopItemData,

  Returns

• BeginBankIdOnFileVerification

  Begin a BankId authentication with a autoStartToken that is valid on desktop and mobile

• BeginBankIdVerification

  Begins a BankID verification session. After the request returns successfully, the member may open their
  BankID app and verify their Tradera account.
  Use `GetBankIdVerificationProgress` to check the progress of the verification,
  and use `CancelBankIdVerification` to cancel an ongoing verification.

  Returns

  An object containing a reference (BankIdOrderRef) to the ongoing Verification, or an Error indicating what
  type of error occurred while attempting to begin the Verification.
  When successful, BankIdOrderRef is a non-empty string, and Error is null.
  When failed, BankIdOrderRef is null, and Error is a non-empty string.

• CancelBankIdVerification

  Cancels an ongoing BankID verification.

• 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

• GetBankIdVerificationProgress

  Gets progress and completion status for an ongoing BankID verification.

  Returns

  An object containing a flag (IsCompleted) that indicates whether the verification has completed.
  Additionally, a description of the progress (Progress) of the ongoing verification is supplied,
  or an Error indicating what type of error occurred.

• GetItem

  Gets an Item for the current seller.

  Parameters

  1. itemId, The Id of the Item (auction)

  Returns

  Item (auction) object

• GetMemberPaymentOptions

  Gets a member''s available payment options

  Parameters

  1. memberId,

  Returns

• GetRequestResults

  Retrieves final request results for asynchronous requests like: AddShopItem and SetPriceOnShopItems .

  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. Does not get any items with a start date which is in the future, regardless of parameter values.

  Parameters

  1. categoryId, The Id of the category to look for items in (use 0 for all categories)
     eg. 344481 for test item category
  2. filterItemType, Item types to return:
     "All"
     "Auction"
     "PureBuyItNow"
     "ShopItem"
  3. filterActive, The filter to use:
     "All" = All,
     "Active" = Only active items (EndDate > NOW),
     "Inactive" = Only inactive items (EndDate < NOW)
     
     Can be overridden with either the minEndDate or maxEndate parameters.
  4. 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.
  5. 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.
  6. maxStartDate, Will return items with StartDate < than this parameter.
     Either send NULL or a DateTime. Default (when NULL is passed) is to use the current time, i.e. only return items that are started

  Returns

  Array of items

• 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.
  - Feedback has already been left for the transaction by the requesting user
  - Transaction has been deleted by Tradera.

• LeaveOrderFeedbackToBuyer

  Leaves feedback for an order to buyer.

  Parameters

  1. orderNumber, The OrderNumber to leave feedback for.
  2. comment, A freetext comment (80 characters)
  3. type, Type of feedback to leave: Positive or Negative

• 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.
  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.

• 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.

• SetPricesOnNonShopItems

  Sets the different price-types on a non shop item.
  
  To use this method the auction cannot have bids.

  Parameters

  1. itemId, The id of the auction.
  2. openingPrice, The auction start price.
     - Is Mandatory.
     - Has to be less then ReservedPrice (if ReservedPrice set)
     - Has to be less then BinPrice (if BinPrice set)
  3. ReservedPrice, !Optional. The reservation price. (40kr)
     - Is not Mandatory.
     - The reservation price is the lowest accepted price for the auction.
     - It costs 40kr to add a reservation price and it is not beneficial for low price auctions
     - Has to be greater then OpeningPrice
     - Has to be less then BinPrice
     - The ReservedPrice cannot be removed if set. It can only be changed.
     - To not add a ReservedPrice set the ReservedPrice object to null.
  4. BinPrice, !Optional. The buy it now price.
     - Is not Mandatory.
     - BinPrice is a price on which you can sell the product before having any bids.
     - Has to be greater then OpeningPrice.
     - Has to be greater then ReservedPrice (if ReservedPrice is set)
     - To not add a BinPrice set the BinPrice object to null.
     - To remove a BinPrice set the BinPrice object to null.

• 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 .

• 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.
  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.
  
  Note that the Quantity field is a delta - pass a negative value to decrease
  the quantity and a positive value to increase it. Use AbsoluteQuantity if
  you wish to set the quantity to an absolute value.

  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.

• UpdateShopItemVariant

• 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 .

• ValidateCampaignCode

  Validates a campaign code given the user context and the supplied category id.
  NOTE: This method is considered internal and might be changed at any time without prior notice.

  Parameters

  1. campaignCode, Campaign code to validate
  2. categoryId, The category to be used in the validation context

  Returns

  Campaign code details and validation info