eBid API Docs - JSON

AFTER SALE LOG Methods
eBid API methods that relate to the after sale process, once a sale has been agreed. Payment, making contact, feedback etc.

GetListingASL
Returns the ASL (After Sale Log) details for a given listing. If more than one sale has been made this will return more than one ASL.

API Command: GetListingASL
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetListingASL" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"SaleID":

INT,

# Sale ID ( sale record ) .

(optional)

"ListingID":

"STRING"

# Listing ID

(optional)

}

RESPONSE

{
"APIVersion": "",

"ListingID":

INT,

# ID number of the listing.

(required)

"ListingTitle":

"STRING",

# Title of the listing.

(required)

"Live":

VALUES SET,

# Is this listing currently running?

(required)

Y=Yes | =No (empty value)

"ASL":

[{

"Sale":

{

"SaleID":

INT,

# Sale ID

(required)

"Buyer":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Buyer info

(required)

"UnixTime":

INT,

# Unix Timestamp when sale made

(required)

"Time":

"STRING",

# Printable when sale made

(required)

"PurchasePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price

(required)

"PurchasePriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price exchanged to current country currency

(required)

"Quantity":

INT,

# Quantity of items purchased

(required)

"ShippingPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"ShippingPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price exchanged to current country currency

(required)

"TotalAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Total sale amount

(required)

"TotalAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total Amount exchanged to current country currency

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

}

# Items Seller object

(required)

"Status":

{

"InvoiceStatus":

VALUES SET,

# Y/N value is invoice sent

(required)

Y=yes | N=No

"InvoiceStatusText":

"STRING",

# is invoice sent - Yes/No text status

(required)

"PaymentStatus":

VALUES SET,

# C/R/NP/Y/YN/N values where C - Cancelled, R - Refunded, NP - Non Payed , Y - Payed, YN - Pending , N - Not Yet

(required)

"PaymentStatusText":

"STRING",

# Payment status printable text - Cancelled / Refunded / Non Payed / Payed / Pending / Not Yet

(required)

"ShipmentStatus":

VALUES SET,

# Y/N/C - is item shipped - yes , no , cancelled

(required)

Y=Shipped | N=Not Shipped | C=Cancelled

"ShipmentStatusText":

"STRING",

# text value for shipment status - Yes / No / Cancelled

(required)

"FeedbackLeftStatus":

VALUES SET,

# Is feedback left by current user - Y/N/C - Yes, No , Cancelled

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackLeftStatusText":

"STRING",

# Is feedback leaved by current user - Yes / No / Cancelled

(required)

"FeedbackReceivedStatus":

VALUES SET,

# Y/N/C - is current user received feedback for this item ( Yes / No / Cancelled )

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackReceivedStatusText":

"STRING"

# printable feedback received for this item status - Yes / No / Cancelled

(required)

"AvailableOptions":

{

"Option":

[{

"ID":

INT,

# ASL option ID

(required)

"Code":

VALUES SET,

# ASL string code like (PayNowViaPPPay, RequestInvoiceFromSeller ...) , use this to make all checks in code.

(required)

"Text":

"STRING",

# Option title ( use to show on screen as choose option )

(required)

"ExtraParam":

"STRING",

# Some extra params for option , currently used only for question reply and include question ID .

(required)

"TextNeed":

VALUES SET

# Y/N/C - Y = user required enter text for this option (need promt for it ), N = text is not need , C - option cannot be submit back , need process other way then submit to ebid ( usially payments , need redirect to payment system)

(required)

Y=user required enter text | N=text is not need | C=option cannot be submit

}]

(required)

# Available after sale actions

(required)

"Log":

{

"Message":

[{

"ID":

INT,

# ASL log entry ID

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# ASL log user ( who logged )

(required)

"UnixTime":

INT,

# Unix timestamp when entry added

(required)

"Time":

"STRING",

# Printable time when log entry added

(required)

"Type":

VALUES SET,

# A numeric value relating to the type of ASL entry.

(required)

"TextType":

"STRING",

# Log entry type ( printable text )

(required)

"Details":

"STRING",

# Log entry message ( entered by user or generated )

(required)

"ReplyTo":

INT,

# ReplyID to some other log entry ( only for questions replies )

(required)

"NudgeCount":

INT,

# Nudge count ( questions only )

(required)

"LastNudgeUnixTime":

INT,

# Unix Timestamp of last nudge ( questions only )

(required)

"LastNudge":

"STRING",

# Last nudge time ( printable format )

(required)

"FeedbackMessage":

"STRING"

# Feedback message ( only for feedbacks )

(required)

}]

(required)

# ASL Log entry

(required)

}]

(required)

}

SaveListingASL
Save an entry to an After Sale Log (ASL). The Sale ID is required before submitting. A value for the OPTION variable is also required describing the action taking place, can be code or id. Always make a call to "GetListingASL" to obtain the current available options for the listing in question.

BUYING Methods
eBid API methods that enable or are related to BuyNow, Bidding and Offering (MaO).

GetCheckoutData
This API method will return all the data required to form a payment checkout. It includes item costs, shipping costs, discounts. Some options are available for the user to choose from, eg. shipping methods and destination. If user changes details then the method must be called again to show the updated costs relating to the changes, eg. shipping costs, sales taxes etc. Once the costs are finalised then the method "SaveCheckoutSubmit" will be called to redirect user to the payment processor (PayPal, PPPay and Skrill only). If no online payment processor (see "AlsoPaymentAvailable" field) is accepted by the seller details are for viewing only.

API Command: GetCheckoutData
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetCheckoutData" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"ListingID":

INT,

# Listing ID to checkout . If there few listings to pay then first one

(required)

"SinglePayment":

VALUES SET,

# Y/N value. If set to Y then pay only this listing.

(optional)

Y=yes | N=No

"ShipTo":

VALUES SET,

# ISO country to calculate shipping to . Like 'uk', 'us' etc

(optional)

"ShipToZip":

"STRING",

# Zip/Postcode to calculate shipping to . If it need for calculations.

(optional)

"TaxTo":

"STRING"

# State to calculate taxes . Only applicable if taxes is set for this listing and shipping is inside country.

(optional)

}

RESPONSE

{
"APIVersion": "",

"Items":

{

"Item":

[{

"ListingID":

INT,

# Listing ID

(required)

"SaleID":

INT,

# Sale ID ( purchase record )

(required)

"ListingTitle":

"STRING",

# Listing Title

(required)

"Quantity":

INT,

# Purchase quantity

(required)

"QuantityDown":

INT,

# Quantity for shipping calculation ( some items may be group up for shipping purposes )

(required)

"PurchasePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Purchase price

(required)

"PurchasePriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Purchase price exchanged to current site currency

(required)

"PurchasePricePay":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# If this object is filled the payment need do for this currency and in this country . Some countries do not support payments in national currency .

(required)

"ShippingPrices":

{

"Option":

[{

"ID":

"STRING",

# Shipping option id (eBid shipping code )

(required)

"Name":

"STRING",

# Shipping option name like "Royal Mail Airmail"

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price exchanged to current site currency

(required)

"PricePay":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# If this price is filled , then payment will be done in this currency . Some countries can pay only in dollars or curriences other then their

(required)

"PriceCanChange":

"STRING",

# Y/empty value) - if Y then price can be changed by buyer before pay , need allow user to enter this price . This can happen when price is in description and seller did not set it .

(required)

"ErrorMessage":

"STRING"

# If price can be fetched from third provider this field include error fron this provider . Order cannot be payed at all if this field include error.

(required)

}]

(required)

# This tag can be empty if shipping combined with other rows . Or include one or more option to choose by buyer as alternative shippings.

(required)

"Taxes":

{

"TaxApplied":

VALUES SET,

# Y/(empty value) - is tax applied for this item

(required)

Y=Yes | =No (empty value)

"Amount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Tax amount ( items only )

(required)

"AmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Tax amount ( items only ) exchange to current site local currency

(required)

"AmountPay":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# If this tag filled then tax need show in this currency , some countries support payments in dolloars only or in other non local currency .

(required)

"Percent":

DECIMAL,

# Tax percent 0 - 99.9 value

(required)

"AlsoNeedFromShipping":

VALUES SET

# Y/(empty value) , is tax will be applied also from shipping price .

(required)

Y=Yes | =No (empty value)

(required)

}]

(required)

"ShipTo":

VALUES SET,

# Destantion country to which shippings calculated . ISO code like 'us' , 'eu' , 'uk'

(required)

"ShipToZip":

"STRING",

# Zip / postal code to which shipping calculated , it can be empty if not required

(required)

"PPPayAvailable":

VALUES SET,

# Y/(empty value) - is PPPay payment option available

(required)

Y=Yes | =No (empty value)

"PayPalAvailable":

VALUES SET,

# Y/(empty value ) is PayPal payment option available to pay this order

(required)

Y=Yes | =No (empty value)

"SkrillAvailable":

VALUES SET,

# Y/(empty value ) is Skrill payment option available to pay this order

(required)

Y=Yes | =No (empty value)

"AvailableTo":

"STRING",

# Comma separated countries to which this shipping is available like "uk,us,eu" ...

(required)

"HomeCountry":

VALUES SET,

# Seller home ISO country code like 'uk' , 'us'

(required)

"ShipZipRequiredDom":

"STRING",

# Y/(empty value) - is zip/postcode required to calculate domestic shippings

(required)

"ShipZipRequiredInt":

VALUES SET,

# Y/(empty value) - is zip/postcode required to calculate international shippings

(required)

Y=Yes | =No (empty value)

"TaxCalculatedTo":

"STRING",

# State code to which calculated taxes . Like 'NY' , 'FL' , etc

(required)

"AlsoPaymentAvailable":

"STRING",

# List of payment options available for this order excep paypal/pppay/skrill. Is text can be shown to infom user .

(required)

"ItemsDiscountAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Order discount amount ( deducted from items price )

(required)

"ItemsDiscountAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Order discount amount ( deducted from items price )exchanged to current site currency .

(required)

"ShippingDiscount":

{

"ShippingDiscountAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping discount amount , only if discount is fixed amount . If percentage , this field will be empty .

(required)

"ShippingDiscountAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping discount amount , only if discount is fixed amount . If percentage , this field will be empty .

(required)

"ShippingDiscountPercent":

"STRING"

# This filed is not empty if shipping discount set as percent . Code must be ready to recalculate shipping discount as user choose shipping method and choosen price changed.

(required)

# Shipping discount for order

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

}

# Seller user information

(required)

}

SaveBid
This API method allows a bid to be saved on an eBid auction listing.

SaveBuyNow
This API method allows a BuyNow to be recored on alisting.

API Command: SaveBuyNow
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "SaveBuyNow" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"ListingID":

INT,

# Listing ID

(required)

"Quantity":

"STRING",

# Max quantity you wish to buy , must not exceed max items available to buynow

(required)

"Variation": # (added in 2.0)

{

[

"ItemSpecifics":

{

"Name":

"STRING",

# Tag name

(required)

"Value":

"STRING"

# Specifics value

(required)

# Variation specifics

(required)

]

# Variation to buy , only for variation listings ( IS OPTIONAL ) (added in 2.0)

(optional)

}

RESPONSE

{
"APIVersion": "",

"ListingID":

INT,

# Listing ID

(required)

"ListingTitle":

"STRING",

# Listing title

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Purchase price ( Buynow price )

(required)

"Quantity":

INT,

# Quantity purchased

(required)

"Time":

"STRING",

# Printable time when purchase done ( now )

(required)

"UnixTime":

INT,

# Unix timestamp when purchase done ( now )

(required)

"SaleID":

INT,

# Topay ( purchase ) record ID

(required)

"Code":

"STRING",

# string 'ok'

(required)

"PaymentRequiredImmediately":

VALUES SET,

# Y/empty value , is payment required immediately for this listing

(required)

Y=Yes | =No (empty value)

"PaymentRequiredImmediatelySec":

INT,

# Seconds to max time payment required

(required)

"PaymentRequiredImmediatelyLeft":

"STRING",

# Time left until payment required ( printable )

(required)

"PaymentRequiredImmediatelyUnixTime":

INT,

# Payment require to this time ( Unix timestamp )

(required)

"PaymentRequiredImmediatelyTime":

"STRING",

# Payment require to this time ( printable )

(required)

"Variation":

{

[

"Image":

{

"ImageLarge":

"STRING",

# Large Image URL

(required)

"ImageSmall":

"STRING",

# Small Image URL

(required)

"ImageMedium":

"STRING",

# Medium Image URL

(required)

"eBidImage":

VALUES SET

# Is image stored at eBid server

(required)

Y=yes | N=No

(optional)

]

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Variation Price

(required)

"QuantitySold":

INT,

# Quantity Sold

(required)

"Barcode":

"STRING",

# UPC/EAN/ISBN/MPN code

(required)

"ItemSpecifics":

{

"Name":

"STRING",

# Specifics tag name

(required)

"Value":

"STRING"

# Specifics value

(required)

# Variation Specifics

(required)

}

(optional)

}

SaveCheckoutSubmit
This method takes the data submitted from "GetCheckoutData" and will return a URL to redirect to to make payment.

API Command: SaveCheckoutSubmit
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "SaveCheckoutSubmit" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"ShipTo":

VALUES SET,

# ISO country to calculate shipping to . Like 'uk', 'us' etc

(optional)

"ShipToZip":

"STRING",

# Zip/Postcode to calculate shipping to . If it need for calculations.

(optional)

"TaxTo":

"STRING",

# State to calculate taxes . Only applicable if taxes is set for this listing and shipping is inside country.

(optional)

"Topay":

[INT],

# Topay ID ( sale record ID ) to pay . One or few .

(required)

"Back_URL":

"STRING",

# Back URL to return after payment done

(required)

"Cancel_URL":

"STRING",

# URL to return back if payment cancelled

(required)

"Payment_Type":

"STRING",

# Payment type : 'pppay', 'paypal', 'skrill'

(required)

"ListingID":

INT

# Listing ID . If there is few ones , then first one.

(required)

}

RESPONSE

{
"APIVersion": "",

"URL":

"STRING"

# URL to payment processor , need redirect user to this URL to allow to pay

(required)

}

SaveOffer
This API method allows an offer (MaO)to be recorded on a listing the has the Make an Offer (MaO) facility switched on.

API Command: SaveOffer
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "SaveOffer" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"ListingID":

INT,

# Listing ID to make offer for

(required)

"Quantity":

INT,

# Quantity to make offer for

(required)

"Price":

DECIMAL,

# Offer price per item

(required)

"BuyerNote":

"STRING"

# Buyer Note to seller

(required)

}

RESPONSE

{
"APIVersion": "",

"ListingID":

"STRING",

# Listing ID

(required)

"ListingTitle":

"STRING",

# Listing title

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offer price

(required)

"Quantity":

INT,

# Offer Quantity

(required)

"Time":

"STRING",

# Printable time when offer saved (now)

(required)

"UnixTime":

INT,

# Unix timestamp where offer saved

(required)

"AutoAccept":

"STRING"

# Auto Accept state : 'Accepted' , 'Rejected' or empty string if none of these

(required)

}

SaveOfferBuyerAcceptReject
This method is used when a buyer wishes to acceptor reject a counter offer (MaO) they have received from a seller.

API Command: SaveOfferBuyerAcceptReject
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "SaveOfferBuyerAcceptReject" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"OfferID":

INT,

# Offer ID to accept/reject counter offer

(required)

"ListingID":

INT,

# Listing ID

(required)

"Accept":

VALUES SET

# Y/N value . Accept or reject counter offer.

(required)

Y=yes | N=No

}

RESPONSE

{
"APIVersion": "",

"ListingID":

INT,

# Listing ID

(required)

"ListingTitle":

"STRING",

# Listing title

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Countered price

(required)

"Quantity":

INT,

# Offer quantity

(required)

"Time":

"STRING",

# Printable time when buyer accepter or rejected offer (now)

(required)

"UnixTime":

"STRING",

# Unix timestamp when buyer accepter or rejected offer

(required)

"State":

VALUES SET,

# Action done : 'Accepted' , 'Rejected'

(required)

Accepted=Accepted | Rejected=Rejected

"Code":

"STRING"

# Always 'ok'

(required)

}

SaveOfferSellerAcceptReject
This method is used when a seller wishes to accept, reject or make a counter offer on a offer (MaO) they have received.

API Command: SaveOfferSellerAcceptReject
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "SaveOfferSellerAcceptReject" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"OfferID":

INT,

# Offer ID to accept or reject

(required)

"ListingID":

INT,

# Listing ID

(required)

"Accept":

VALUES SET,

# Y/N/C - Yes , No , Countered . If countered , then price field required.

(required)

Y=Accepted | N=Not Accepted | C=Countered

"CounterPrice":

DECIMAL,

# Counter price , only if Accept = C .

(optional)

"SellerNote":

"STRING"

# Is optional only if offer countered .

(optional)

}

RESPONSE

{
"APIVersion": "",

"ListingID":

INT,

# Listing ID

(required)

"ListingTitle":

"STRING",

# Listing title

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Counter offer price ( if present )

(required)

"Quantity":

INT,

# Offer Quantity

(required)

"Time":

"STRING",

# Printable time of accept or reject offer (now)

(required)

"UnixTime":

INT,

# Unix TimeStamp of accept or reject offer (now)

(required)

"State":

VALUES SET,

# Offer state - 'Accepted' , 'Rejected' or 'Countered'

(required)

Accepted=Accepted | Rejected=Rejected | Countered=Countered

"Code":

"STRING"

# string 'ok'

(required)

}

EBID STORE Methods
eBid API methods relating to eBid Stores.

GetEbidStoreCategories
This API method returns all eBid Store categories in a given eBid Store or the subcategories below a certain hierarchy level if "ParentStoreCategoryID" is set.

GetEbidStoreCategoryList
Returns the number of eBid Stores located in a certain category. Every eBid Store is categorised based on the items it sells when creating the store.

GetEbidStores
Returns information about a single eBid Store or alternatively a list of eBid Stores owned by a single user.

API Command: GetEbidStores
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetEbidStores" ,

"StoreID":

INT,

# Store ID , if set only this store returned

(optional)

"UserID":

INT

# If set only this field then all stores for this user will return

(optional)

}

RESPONSE

{
"APIVersion": "",

"StoreID":

INT,

# Store ID

(required)

"Owner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Store owner

(required)

"Title":

"STRING",

# Store title ( name )

(required)

"Description":

"STRING",

# Store description

(required)

"Category":

INT,

# Store classification category ID ( ebid categories )

(required)

"Image":

"STRING",

# URL of store banner image

(required)

"ListingsCount":

INT,

# Count of listings in this store

(required)

"Link":

"STRING",

# URL to store ( link to eBid )

(required)

"Online":

VALUES SET

# Y/N value is store online

(required)

Y=yes | N=No

}

SearchEbidStores
This API method will search eBid Stores according to keywords located in the title of the eBid Store.

API Command: SearchEbidStores
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "SearchEbidStores" ,

"Start":

INT,

# Offset for stores table

(optional)

"RowsLimit":

INT,

# How many stores return in result. max 20

(optional)

"Sort":

"STRING",

# Sort option : 'TITLE_ASC', 'TITLE_DESC', 'COUNT_ASC', 'COUNT_DESC'

(optional)

"CategoryID":

INT,

# Store classified categoryid

(optional)

"Keyword":

"STRING"

# Search keyword

(optional)

}

RESPONSE

{
"APIVersion": "",

"TotalItemsCount":

INT,

# Total items found

(required)

"Store":

{

"StoreID":

INT,

# Store ID

(required)

"Owner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Store owner

(required)

"Title":

"STRING",

# Store title ( name )

(required)

"Description":

"STRING",

# Store description

(required)

"Category":

INT,

# Store classification category ID ( ebid categories )

(required)

"Image":

"STRING",

# URL of store banner image

(required)

"ListingsCount":

INT,

# Count of listings in this store

(required)

"Link":

"STRING",

# URL to store ( link to eBid )

(required)

"Online":

VALUES SET

# Y/N value is store online

(required)

Y=yes | N=No

}

(required)

}

ITEM Methods
These functions does not require login and return listings data

GetListingBids
Returns all listing bids, BuyNows and successful accepted MaO (offers). If "LoginKey" (user is logged in) field is sent in request then the response will house more information.

API Command: GetListingBids
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetListingBids" ,

"LoginKey":

"STRING",

# Login key if user logged in , it change bids view , is optional .

(optional)

"ListingID":

INT

# Listing ID

(required)

}

RESPONSE

{
"APIVersion": "",

"ListingID":

INT,

# Listing ID

(required)

"Bids":

{

"Bid":

[{

"BidID":

INT,

# Bid ID

(required)

"BuyNow":

VALUES SET,

# Y/(empty value) - is this buynow bid record

(required)

Y=Yes | =No (empty value)

"UserID":

INT,

# Bidder UserID ( possible 0 - when name hidden , adult listings)

(required)

"Username":

"STRING",

# Bidder username

(required)

"UnixTime":

"STRING",

# Unix Timestamp when bid made

(required)

"Amount":

"STRING",

# Bid amount , possible value "Not Public" for non public values

(required)

"Allocation":

INT,

# Quandtity allocated by this bid ( for dutch listings possible less then quantity )

(required)

"Quantity":

INT,

# Bid quantity

(required)

"QuantityText":

"STRING",

# Printable bid quantity , use to output

(required)

"Time":

"STRING",

# Printable bid time

(required)

"MAO":

VALUES SET,

# Y/(empty value) - is bid generated by successful offer

(required)

Y=Yes | =No (empty value)

"IconType":

VALUES SET,

# Bid icon type - p, r, b ( proxy , reserve meet , buynow )

(required)

p=Proxy | r=Reserve meet | b=Buynow

"IconImages":

"STRING",

# Icon images tags , include IMG tage , possible few together.

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Bidder user object , may not be here if private listing , or can be full version if some params present.

(optional)

"HiddenName":

VALUES SET,

# Y/(empty value) - is name hidden

(required)

Y=Yes | =No (empty value)

"NotPublic":

VALUES SET,

# Y/(empty value) - is amount public or no

(required)

Y=Yes | =No (empty value)

"BuyerFullInfo":

VALUES SET

# Y/(empty value) - is User tag include full version of user object

(required)

Y=Yes | =No (empty value)

}]

(required)

}

GetListingMultiple
Similar to "GetListingSingle" but only for live listings, but retrieves data for multiple listings in a single call. Send multiple "ListingID" instances within your request comma delimited. Will not return closed listing data.

API Command: GetListingMultiple
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetListingMultiple" ,

"Listings":

{

"ListingID":

[INT]

(repeated)

(required)

"ShipTo":

VALUES SET,

# ISO country code to which need calculate shipping

(optional)

"ShipToZip":

"STRING"

# Postcode/zip for shipping calulations

(optional)

}

RESPONSE

{
"APIVersion": "",

"Listing":

{

"ListingID":

INT,

# Listing ID

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Listing Seller data

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Listing category

(required)

"Category2":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Second category , if present or empty tag is not

(optional)

"Title":

"STRING",

# Listing title

(required)

"SubTitle":

"STRING",

# Listing subtitle ( if present )

(required)

"Bold":

VALUES SET,

# Y/N value , is listing bold

(required)

Y=yes | N=No

"Highlight":

VALUES SET,

# Y/N value , is listing highlighten in listings

(required)

Y=yes | N=No

"Movie":

"STRING",

# Listing movie ID

(required)

"Brand":

"STRING",

# Listing brand

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image large version ( or empty )

(required)

"PrimaryImageSmall":

"STRING",

# URL to Listing primary image small version or empty

(required)

"PrimaryImageMedium":

"STRING",

# URL to Listing primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N - Is image uploaded to eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N , is image is part of UPC/EAN library

(required)

"Quantity":

INT,

# Listing quantity ( 1 - max value )

(required)

"StartTime":

"STRING",

# Listing start time printable version

(required)

"StartTimeUnix":

INT,

# Start time , Unixtimestamp

(required)

"StartPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing Start price value

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"NextBid":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Next prossible bid or empty if not applicable

(required)

"Increment":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Increment value

(required)

"BidCount":

INT,

# Count of bids already made

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"BuyNowAvailable":

INT,

# Items quantity available for BuyNow

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price for this Listing

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price exchanged to local currency ( current country view )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price exchanged to current country currency

(required)

"Views":

INT,

# Listing views count ( how many it was viewed on eBid )

(required)

"Description":

"STRING",

# Listing Description

(required)

"Store":

{

"StoreID":

INT,

# Store ID

(required)

"Owner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Store owner

(required)

"Title":

"STRING",

# Store title ( name )

(required)

"Description":

"STRING",

# Store description

(required)

"Category":

INT,

# Store classification category ID ( ebid categories )

(required)

"Image":

"STRING",

# URL of store banner image

(required)

"ListingsCount":

INT,

# Count of listings in this store

(required)

"Link":

"STRING",

# URL to store ( link to eBid )

(required)

"Online":

VALUES SET

# Y/N value is store online

(required)

Y=yes | N=No

# Listing Store

(required)

"StoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Store category where listing listed ( or empty if not in store )

(required)

"ParentStoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Parent Store category where it listed or empty value

(required)

"AutoExtended":

VALUES SET,

# Y/N value , is autoextend set for Listing

(required)

Y=yes | N=No

"Barcode":

"STRING",

# UPC/EAN barcode code or empty value , or special value "EXEMPT"

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"ItemCondition":

{

"ID":

VALUES SET,

# Item condition id , n - new , u - used , s - unused , r - refurbished , '' - any

(required)

n=New | u=Used | s=Unused | r=Refurbished | =Any

"Name":

"STRING",

# Printable name of option

(required)

"APIName":

"STRING"

# API name to refer for API ( NEW , USED, UNUSED, REFURBISHED, ANY )

(required)

# Listing item condition

(required)

"PaymentOptions":

{

"PaymentOption":

[{

"ID":

INT,

# Option ID

(required)

"Name":

"STRING"

# Option name

(required)

}]

(required)

# Payment options available for listing

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"ShipTo":

VALUES SET,

# ISO country code for which current shipping price calculated

(required)

"ShipToName":

"STRING",

# Country name to which current shipping prices calculated

(required)

"ShipToZip":

"STRING",

# zip/postcode to which current shipping price calculated ( if required or present ).

(required)

"Shippings":

{

"DomesticShippings":

{

"Type":

"STRING",

# constant - "calculated"

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions (cm , or inch)

(required)

"Weight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Package weight ( for some countries is kg and gramms )

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

"STRING",

# Package girth ( inch )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Fedex package options or empty values

(optional)

}],

(required)

"PackageName":

"STRING"

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"DomesticShippings":

{

"Type":

"STRING",

# "flat" - is hardcoded , can be used to indefiny shipping type

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL

# Extra item shipping price ( if different then 1st item shipping price and if multi item listing )

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# shipping object type , hardcoded value "calculated"

(required)

"Handling":

DECIMAL,

# handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions ( in cm or inch depend from country )

(required)

"Weight":

{

"Lbs":

"STRING",

(required)

"Oz":

"STRING"

(required)

# Package weigh lb & oz or kg and gramms depend from country

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"PackageName":

"STRING",

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

DECIMAL,

# Package girth ( if applicable )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Options filled only if package is fedex

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# postage type , hardcoded value "flat"

(required)

"Option":

[{

"ShippingService":

"STRING",

# Postage service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL,

# Extra item shipping price ( if quantity more then 1 and shipping price is different then 1st item )

(required)

"AvailableTo":

VALUES SET

# Comma separated ISO country lists to which this shipping possible ( like "uk,us,de" )

(required)

}]

(required)

"Shipping":

{

"Code":

"STRING",

# Shipping method eBid code

(required)

"Name":

"STRING",

# Shipping method postage name ( like Royal Mail 1st Class , Parcelforce (2 Day Delivery) , etc )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"PriceExchanged":

"STRING",

# Shipping price exchanged to current site currency

(required)

"Calculated":

"STRING",

# Y/N - is price received from postage service provider ( N - defined directly by user )

(required)

"ShippingTo":

"STRING",

# ISO Country code for this shipping price ( like uk , us, etc )

(required)

"ShippingToName":

"STRING",

# Country Name for this shipping price ( like United States , Canada , etc )

(required)

"ExtraDetails":

"STRING"

# Extar details for this postage method ( Not available or to be calculated ) , can replace price by this text

(required)

}

(required)

# Listing shipping data . Depend from parameters and listing shipping data this tag may include different optional shipping parameters.

(required)

"MinShippingCost":

"STRING",

# Minimal shipping cost for this listing to choosed or default country

(required)

"MinShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"MinShippingCostName":

"STRING",

# Minimal shipping cost postage method ( printable label like "Royal Mail Airmail" ...)

(required)

"UserListingsCount":

INT,

# Listings count for this listing , is optional depend from parameters.

(optional)

"ShipZipRequiredDom":

VALUES SET,

# Y/(empty value) , is zip postacode required to calculate Domestic shipping prices

(required)

Y=Yes | =No (empty value)

"ShipZipRequiredInt":

VALUES SET,

# Y/(empty value) is zip/postcode required to calculate international price

(required)

Y=Yes | =No (empty value)

"Bids":

{

"Bid":

[{

"BidID":

INT,

# Bid ID

(required)

"BuyNow":

VALUES SET,

# Y/(empty value) - is this buynow bid record

(required)

Y=Yes | =No (empty value)

"UserID":

INT,

# Bidder UserID ( possible 0 - when name hidden , adult listings)

(required)

"Username":

"STRING",

# Bidder username

(required)

"UnixTime":

"STRING",

# Unix Timestamp when bid made

(required)

"Amount":

"STRING",

# Bid amount , possible value "Not Public" for non public values

(required)

"Allocation":

INT,

# Quandtity allocated by this bid ( for dutch listings possible less then quantity )

(required)

"Quantity":

INT,

# Bid quantity

(required)

"QuantityText":

"STRING",

# Printable bid quantity , use to output

(required)

"Time":

"STRING",

# Printable bid time

(required)

"MAO":

VALUES SET,

# Y/(empty value) - is bid generated by successful offer

(required)

Y=Yes | =No (empty value)

"IconType":

VALUES SET,

# Bid icon type - p, r, b ( proxy , reserve meet , buynow )

(required)

p=Proxy | r=Reserve meet | b=Buynow

"IconImages":

"STRING",

# Icon images tags , include IMG tage , possible few together.

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Bidder user object , may not be here if private listing , or can be full version if some params present.

(optional)

"HiddenName":

VALUES SET,

# Y/(empty value) - is name hidden

(required)

Y=Yes | =No (empty value)

"NotPublic":

VALUES SET,

# Y/(empty value) - is amount public or no

(required)

Y=Yes | =No (empty value)

"BuyerFullInfo":

VALUES SET

# Y/(empty value) - is User tag include full version of user object

(required)

Y=Yes | =No (empty value)

}]

(required)

# Bids history for this listing , only if it required in initial query , or empty value

(required)

"Type":

VALUES SET,

# "n" or "d" char , Listing type n-single item listing , d - multi item listing

(required)

n=Single item listing | d=Multi item listing

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing/listing price

(required)

"AdultHiddenName":

[{

"UserID":

INT,

# UserID

(required)

"Username":

"STRING"

# Hidden name replacement like "hiddenname1"

(required)

}],

(required)

"AdultHide":

"STRING",

# Y/N value - is listing opted as Adult Hide Usernames

(required)

"ItemsAvailableBid":

INT,

# Quantity available to bid . If holiday notice set - bidding is not available .

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empy value) - is bidding available for this listing now . Do not show bid form if this field is not set to Y.

(required)

Y=Yes | =No (empty value)

"HolidayNotice":

VALUES SET,

# Y/N value . Is User notice is holiday ( user is on vacancy , and bidding not available )

(required)

Y=yes | N=No

"HolidayNoticeText":

"STRING",

# Holiday notice text , If notify is present then user text or empty.

(required)

"Watch":

VALUES SET,

# Y/N value , is current user watching this listing , only if login info sent with request .

(required)

Y=yes | N=No

"ListingStateSuccess":

VALUES SET,

# Y/N value , is this listing for current user is success ( high bidder , buyed via buynow ) , empty value if user login info not sent with query

(required)

Y=yes | N=No

"ListingStateMessage":

"STRING",

# Listing status message normally shown on eBid listing page at top , only for logged in users ( if login info sent with query )

(required)

"ListingQuestionState":

"STRING",

# Listing question state , only if login data sent with this query e.q. for logged info only . Or empty.

(required)

"Live":

VALUES SET,

# Y/(empty value) - is listing live , e.q. running . listing is live while it not moved to myeBid closed area ( not just time expired ).

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/N value - Is seller accept offers for this listing .

(required)

Y=yes | N=No

"OffersStatus":

"STRING",

# Offers status normally shown at top of eBid listing page , is not empty if seller accept offers , some offer made , and user logged in ( logged info sent with query )

(required)

"OffersAttentionRequired":

VALUES SET,

# Y/N value , is current offers required logged user attention . For example seller attention required when offers made . Is set only if logged user info provided with query.

(required)

Y=yes | N=No

"OffersHistoryCount":

INT,

# How many offers made for this listing/listing

(required)

"PrimaryMarket":

VALUES SET,

# Primary market ISO country code like "us" , "uk" , "eu" ...

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list like "us,uk,eu" or similar . Listing is available on these eBid markets .

(required)

"ASL":

[{

"Sale":

{

"SaleID":

INT,

# Sale ID

(required)

"Buyer":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Buyer info

(required)

"UnixTime":

INT,

# Unix Timestamp when sale made

(required)

"Time":

"STRING",

# Printable when sale made

(required)

"PurchasePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price

(required)

"PurchasePriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price exchanged to current country currency

(required)

"Quantity":

INT,

# Quantity of items purchased

(required)

"ShippingPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"ShippingPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price exchanged to current country currency

(required)

"TotalAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Total sale amount

(required)

"TotalAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total Amount exchanged to current country currency

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

}

# Items Seller object

(required)

"Status":

{

"InvoiceStatus":

VALUES SET,

# Y/N value is invoice sent

(required)

Y=yes | N=No

"InvoiceStatusText":

"STRING",

# is invoice sent - Yes/No text status

(required)

"PaymentStatus":

VALUES SET,

# C/R/NP/Y/YN/N values where C - Cancelled, R - Refunded, NP - Non Payed , Y - Payed, YN - Pending , N - Not Yet

(required)

"PaymentStatusText":

"STRING",

# Payment status printable text - Cancelled / Refunded / Non Payed / Payed / Pending / Not Yet

(required)

"ShipmentStatus":

VALUES SET,

# Y/N/C - is item shipped - yes , no , cancelled

(required)

Y=Shipped | N=Not Shipped | C=Cancelled

"ShipmentStatusText":

"STRING",

# text value for shipment status - Yes / No / Cancelled

(required)

"FeedbackLeftStatus":

VALUES SET,

# Is feedback left by current user - Y/N/C - Yes, No , Cancelled

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackLeftStatusText":

"STRING",

# Is feedback leaved by current user - Yes / No / Cancelled

(required)

"FeedbackReceivedStatus":

VALUES SET,

# Y/N/C - is current user received feedback for this item ( Yes / No / Cancelled )

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackReceivedStatusText":

"STRING"

# printable feedback received for this item status - Yes / No / Cancelled

(required)

"AvailableOptions":

{

"Option":

[{

"ID":

INT,

# ASL option ID

(required)

"Code":

VALUES SET,

# ASL string code like (PayNowViaPPPay, RequestInvoiceFromSeller ...) , use this to make all checks in code.

(required)

"Text":

"STRING",

# Option title ( use to show on screen as choose option )

(required)

"ExtraParam":

"STRING",

# Some extra params for option , currently used only for question reply and include question ID .

(required)

"TextNeed":

VALUES SET

(required)

Y=user required enter text | N=text is not need | C=option cannot be submit

}]

(required)

# Available after sale actions

(required)

"Log":

{

"Message":

[{

"ID":

INT,

# ASL log entry ID

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# ASL log user ( who logged )

(required)

"UnixTime":

INT,

# Unix timestamp when entry added

(required)

"Time":

"STRING",

# Printable time when log entry added

(required)

"Type":

VALUES SET,

# A numeric value relating to the type of ASL entry.

(required)

"TextType":

"STRING",

# Log entry type ( printable text )

(required)

"Details":

"STRING",

# Log entry message ( entered by user or generated )

(required)

"ReplyTo":

INT,

# ReplyID to some other log entry ( only for questions replies )

(required)

"NudgeCount":

INT,

# Nudge count ( questions only )

(required)

"LastNudgeUnixTime":

INT,

# Unix Timestamp of last nudge ( questions only )

(required)

"LastNudge":

"STRING",

# Last nudge time ( printable format )

(required)

"FeedbackMessage":

"STRING"

# Feedback message ( only for feedbacks )

(required)

}]

(required)

# ASL Log entry

(required)

}],

(required)

"ReservePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing reserve price .

(required)

"AutoOfferAcceptPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers auto accept price

(required)

"AutoOfferDeclinePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers Auto decline price

(required)

"ToRepostCount":

INT,

# Count of autoreposts still due for this listing

(required)

"ToRepostOriginalCount":

INT,

# Initial value of count of listing autoreposts

(required)

"BuynowDiscount":

DECIMAL,

# Current buynow discount rate , is percent from 0 to 99.9

(required)

"ItemSpecificRaw":

"STRING",

# Item specific string , color , sizes , etc . Same format as for bulk upload .

(required)

"Duration":

{

"Days":

INT,

# Days

(required)

"Hours":

INT,

# Hours , available to Seller+ accounts only

(required)

"Mins":

INT,

# Mins , available for Seller+ accounts only

(required)

"UntilSold":

VALUES SET,

# Y/(empty value ) is this listing is Run Until Sold , if so then Days/Hours/Mins is empty

(required)

Y=Yes | =No (empty value)

"AutoExtend":

VALUES SET

# Y/N value , is listing auto extended when busy bids made.

(required)

Y=yes | N=No

# Original listing duration

(required)

"StartListing":

{

"Type":

VALUES SET

# Listing start options : "immediately" , "onfirstbid"

(required)

immediate=Immediate | onfirstbid=On firts bid | custom=Custom time

# Listing start information

(required)

"Tax":

[{

"State":

"STRING",

# Tax state code ( like NY, FL etc )

(required)

"Rate":

DECIMAL,

# Tax rate ( percent )

(required)

"ApplyToShipping":

VALUES SET

# Y/(empty value) - is tax applied to shipping also

(required)

Y=Yes | =No (empty value)

}],

(required)

"URL":

"STRING",

# Listing URL pointed to eBid listing page

(required)

"QuestionsCount":

INT,

# Questions count or empty value. Questions count provided only with options "QuestionsCount=Y" or "QuestionsHistory=Y"

(required)

"Questions":

{

"QuestionID":

INT,

# Question ID

(required)

"ListingID":

INT,

# Listing ID

(required)

"Poster":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Question poster ( user object )

(required)

"UnixTime":

INT,

# Unixtimestamp time when question/reply posted

(required)

"Time":

"STRING",

# Printable question/reply time

(required)

"Message":

"STRING",

# Question/Reply text

(required)

"ReplyToID":

INT,

# ID of question replied or empty if is not reply

(required)

"NudgeCount":

INT,

# Nudge count ( how many times user nudged question )

(required)

"LastNudgeUnixTime":

INT,

# Unix timestamp when question last nudged

(required)

"LastNudgeTime":

"STRING"

# Printable time when question last time nudged

(required)

# Is quertion history only if option "QuestionsHistory=Y"

(required)

"DispatchTime":

{

"Code":

VALUES SET,

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(required)

"Label":

"STRING"

# Dispatch time information ( text ) as shown on eBid Listing pages

(required)

# Item dispatch time information

(required)

"ReturnPolicy":

{

"Code":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(required)

"Label":

"STRING"

# Return policy text

(required)

# Return policy information

(required)

"CategoryPath":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# opted by option "FullCategoryPath=Y"

(required)

"CategoryPath2":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# Category path for second category , if category present and query opted with 'FullCategoryPath=Y'

(required)

"RepostedIDs":

"STRING",

# If listing is closed and in request option RepostedIDs=Y was set , then it return comma separated list of ids of listings reposted from this one . Most recently reposted is first in the list .

(optional)

"Variations":

{

"ImageTag":

"STRING",

# Variation image tag

(required)

[

"Variation":

{

"Image":

{

"ImageLarge":

"STRING",

# Big image URL

(required)

"ImageSmall":

"STRING",

# Small image URL

(required)

"ImageMedium":

"STRING",

# Medium image URL

(required)

"eBidImage":

VALUES SET

# Is image stored at eBid servers ? Y/N

(required)

Y=yes | N=No

# Image info

(optional)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Variation price

(required)

"Quantity":

INT,

# Items quantity

(required)

"QuantitySold":

INT,

# Quantity already Sold

(required)

"Barcode":

"STRING",

# UPC/EAN/MPN code

(required)

"ItemSpecifics":

{

"Name":

"STRING",

# Attribute name

(required)

"Value":

"STRING"

# Attribute value

(required)

# Variation specifics

(required)

]

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING",

# Variation Maximum Price (added in 2.0)

(required)

"ItemSpecifics":

[{

"Name":

"STRING",

# Tag name

(required)

"Value":

"STRING"

# Tag value

(required)

}]

(required)

}

(required)

}

GetListingOffers
This method returns offers (MaO) made on a listing. This will show all offers including pending, rejected, accepted, countered.

API Command: GetListingOffers
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetListingOffers" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"ListingID":

"STRING"

# Listing ID to retrieve offers

(required)

}

RESPONSE

{
"APIVersion": "",

"Offer":

[{

"ListItem":

{

"ListingID":

INT,

# Listing ID

(required)

"Title":

"STRING",

# Listing title

(required)

"BidCount":

INT,

# Bids count ( include BuyNow bids )

(required)

"Currency":

"STRING",

# Listing currency code , like USD , GBP , EUR

(required)

"BuyNowAvailable":

INT,

# Quantity of items available for BuyNow option

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow pprice exchanged to current site currency

(required)

"PrimaryMarket":

"STRING",

# Listing primary market , ISO code like 'us' , 'uk'

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current price exchanged to current site currency

(required)

"Quantity":

INT,

# Listing Quantity ( all items offered by this listing )

(required)

"Views":

INT,

# Current listing page views

(required)

"ShippingCost":

"STRING",

# Lowest postage price

(required)

"ShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Category information

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Seller information

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image ( large version )

(required)

"PrimaryImageSmall":

"STRING",

# URL to primary image ( small version )

(required)

"PrimaryImageMedium":

"STRING",

# Primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N value is main image stored on eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N value is main image is part of UPC/EAN image library

(required)

"ItemsAvailableBid":

INT,

# Items count available to bid

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empty value ) is bidding available for this listing

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/(empty value) is seller accept offers for this item

(required)

Y=Yes | =No (empty value)

"AvailableTo":

VALUES SET,

# Comma separated countries like "us,uk,eu" or similar for which this listing is available

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"tick":

VALUES SET,

# Y/N value , Is this listing is success for current user ( if login info sent with query )

(optional)

Y=yes | N=No

"Winner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Current winner of listing ( if there is )

(optional)

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Listing price , is optional if user logged in

(optional)

"CurrentPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing price , is present only user logged in ( login information sent with query )

(optional)

"UnixTimeEnd":

INT,

# Listing end time , is unix timestamp or special value , 2000000000 = Run Until Sold , 2000000001 - 1 day after 1st bid , 2000000002 - 2 days after 1st bid , etc

(required)

"TimeEnd":

"STRING",

# Listing end time in printable format

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"URL":

"STRING",

# URL to listing page on eBid main site

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING"

# Variation Max Price (added in 2.0)

(required)

"OfferID":

INT,

# This offer ID

(required)

"UnixTime":

"STRING",

# Unix timestamp when offer made

(required)

"Time":

"STRING",

# Printable time when offer made

(required)

"OfferAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# This offer amount

(required)

"OfferAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offer amount exchanged to current country currency

(required)

"Quantity":

INT,

# Offer Quantity

(required)

"CounterOfferUnixTime":

INT,

# Counter offer unix timestamp or zero if no counter offer made

(required)

"CounterOfferTime":

"STRING",

# Printable time when counter offer made or empty if no counter offer

(required)

"CounterOfferAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Counter offer amount

(required)

"CounterOfferAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Counter offer amount exchanged to current site currency

(required)

"StateUnixTime":

"STRING",

# Current status unix timestamp ( when last changed )

(required)

"StateTime":

"STRING",

# Current status printable time ( when last changed )

(required)

"StateCode":

VALUES SET,

# Current status code

(required)

"StateText":

"STRING",

# Current status printable text like ( New , countered , etc )

(required)

"BuyerNote":

"STRING",

# Offer buyer note

(required)

"SellerNote":

"STRING",

# Offer seller note

(required)

"OfferMadeBy":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Buyer info who made this offer

(required)

"OfferExtraState":

VALUES SET,

# Special state code , ATTN / WAIT

(required)

ATTN=Attention required | WAIT=Wait for other side | Y=Offer successful | N=Offer is not successful

"DecideUnixTime":

"STRING",

# Max time ( unix timestamp ) when need decide about this offer or counter offer

(required)

"DecideTime":

"STRING"

# Max time ( printable version ) when need decide about this offer or counter offer

(required)

}]

(required)

}

GetListingSingle
Retrieves information relating to a single listing on eBid. The method has various parameters to generate listing pages similar to those on eBid.net itself. There is no need to use all the options available to you, only the basics will give you most information. If "LoginKey" is submitted (meaning a user is logged in to their account) then extra data is provided.

API Command: GetListingSingle
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetListingSingle" ,

"ListingID":

INT,

# Listing ID . Reqired parameter.

(required)

"ShipTo":

VALUES SET,

# ISO country code to which postage will be calculated .

(required)

"ShipToZip":

"STRING",

# Postage/zip code to which postage will be calculated . Is need only if calculated ( prices obtaiend directly from postage services providers ) postages available to listing origin country.

(optional)

"WithBids":

VALUES SET,

# Y/N value , if this value set to Y , then response will include all bids in tag 'Bids'

(optional)

Y=yes | N=No

"WithASL":

VALUES SET,

# Y/N value . Response will include After Sale Log data in tags 'ASL' , can be zero or more records . Data will be returned ONLY if sent login data , and logged user is a part of ASL communication.

(optional)

Y=yes | N=No

"WithAdultHiddenNames":

VALUES SET,

# Y/N value . If set to Y , then also will return array of hidden usernames , to allow to show somewhere for private listings replacement 'user1' , 'user2' etc . data will be sent in tags 'AdultHiddenName' , may have zero or more results.

(optional)

Y=yes | N=No

"QuestionsHistory":

VALUES SET,

# Y/N value . If set to Y , then also question history returned for this listing in tag 'Questions'

(optional)

Y=yes | N=No

"QuestionsCount":

"STRING",

# Y/N value . Is need return questions count in 'QuestionsCount' tag , if not set this tag will return as ampty.

(optional)

"FullCategoryPath":

VALUES SET,

# Y/N value , if set in Y , then all categories data required to build all category path to listing category will return in tags 'CategoryPath' and 'CategoryPath2' ( is second category set for listing )

(optional)

Y=yes | N=No

"LoginKey":

"STRING",

# Login key retrieved on login procedure , required only if you retrieve ASL data , it change view data for adult private listings for involted users , return watch listing data ('Watch' tag ) , 'ListingStateSuccess' , 'ListingStateMessage' tags data , 'Off

(optional)

"GetUserListingsCount":

"STRING",

# Y/N value . If set to Y then seller listings count will return .

(required)

"RepostedIDs":

"STRING",

# If listing was reposted is new lisings ids need in response . Y/N value;

(optional)

"WithVariations":

VALUES SET

# Include variations data into response or no (added in 2.0)

(optional)

Y=yes | N=No

}

RESPONSE

{
"APIVersion": "",

"ListingID":

INT,

# Listing ID

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Listing Seller data

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Listing category

(required)

"Category2":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Second category , if present or empty tag is not

(optional)

"Title":

"STRING",

# Listing title

(required)

"SubTitle":

"STRING",

# Listing subtitle ( if present )

(required)

"Bold":

VALUES SET,

# Y/N value , is listing bold

(required)

Y=yes | N=No

"Highlight":

VALUES SET,

# Y/N value , is listing highlighten in listings

(required)

Y=yes | N=No

"Movie":

"STRING",

# Listing movie ID

(required)

"Brand":

"STRING",

# Listing brand

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image large version ( or empty )

(required)

"PrimaryImageSmall":

"STRING",

# URL to Listing primary image small version or empty

(required)

"PrimaryImageMedium":

"STRING",

# URL to Listing primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N - Is image uploaded to eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N , is image is part of UPC/EAN library

(required)

"Quantity":

INT,

# Listing quantity ( 1 - max value )

(required)

"StartTime":

"STRING",

# Listing start time printable version

(required)

"StartTimeUnix":

INT,

# Start time , Unixtimestamp

(required)

"StartPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing Start price value

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"NextBid":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Next prossible bid or empty if not applicable

(required)

"Increment":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Increment value

(required)

"BidCount":

INT,

# Count of bids already made

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"BuyNowAvailable":

INT,

# Items quantity available for BuyNow

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price for this Listing

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price exchanged to local currency ( current country view )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price exchanged to current country currency

(required)

"Views":

INT,

# Listing views count ( how many it was viewed on eBid )

(required)

"Description":

"STRING",

# Listing Description

(required)

"Store":

{

"StoreID":

INT,

# Store ID

(required)

"Owner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Store owner

(required)

"Title":

"STRING",

# Store title ( name )

(required)

"Description":

"STRING",

# Store description

(required)

"Category":

INT,

# Store classification category ID ( ebid categories )

(required)

"Image":

"STRING",

# URL of store banner image

(required)

"ListingsCount":

INT,

# Count of listings in this store

(required)

"Link":

"STRING",

# URL to store ( link to eBid )

(required)

"Online":

VALUES SET

# Y/N value is store online

(required)

Y=yes | N=No

# Listing Store

(required)

"StoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Store category where listing listed ( or empty if not in store )

(required)

"ParentStoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Parent Store category where it listed or empty value

(required)

"AutoExtended":

VALUES SET,

# Y/N value , is autoextend set for Listing

(required)

Y=yes | N=No

"Barcode":

"STRING",

# UPC/EAN barcode code or empty value , or special value "EXEMPT"

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"ItemCondition":

{

"ID":

VALUES SET,

# Item condition id , n - new , u - used , s - unused , r - refurbished , '' - any

(required)

n=New | u=Used | s=Unused | r=Refurbished | =Any

"Name":

"STRING",

# Printable name of option

(required)

"APIName":

"STRING"

# API name to refer for API ( NEW , USED, UNUSED, REFURBISHED, ANY )

(required)

# Listing item condition

(required)

"PaymentOptions":

{

"PaymentOption":

[{

"ID":

INT,

# Option ID

(required)

"Name":

"STRING"

# Option name

(required)

}]

(required)

# Payment options available for listing

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"ShipTo":

VALUES SET,

# ISO country code for which current shipping price calculated

(required)

"ShipToName":

"STRING",

# Country name to which current shipping prices calculated

(required)

"ShipToZip":

"STRING",

# zip/postcode to which current shipping price calculated ( if required or present ).

(required)

"Shippings":

{

"DomesticShippings":

{

"Type":

"STRING",

# constant - "calculated"

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions (cm , or inch)

(required)

"Weight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Package weight ( for some countries is kg and gramms )

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

"STRING",

# Package girth ( inch )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Fedex package options or empty values

(optional)

}],

(required)

"PackageName":

"STRING"

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"DomesticShippings":

{

"Type":

"STRING",

# "flat" - is hardcoded , can be used to indefiny shipping type

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL

# Extra item shipping price ( if different then 1st item shipping price and if multi item listing )

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# shipping object type , hardcoded value "calculated"

(required)

"Handling":

DECIMAL,

# handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions ( in cm or inch depend from country )

(required)

"Weight":

{

"Lbs":

"STRING",

(required)

"Oz":

"STRING"

(required)

# Package weigh lb & oz or kg and gramms depend from country

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"PackageName":

"STRING",

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

DECIMAL,

# Package girth ( if applicable )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Options filled only if package is fedex

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# postage type , hardcoded value "flat"

(required)

"Option":

[{

"ShippingService":

"STRING",

# Postage service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL,

# Extra item shipping price ( if quantity more then 1 and shipping price is different then 1st item )

(required)

"AvailableTo":

VALUES SET

# Comma separated ISO country lists to which this shipping possible ( like "uk,us,de" )

(required)

}]

(required)

"Shipping":

{

"Code":

"STRING",

# Shipping method eBid code

(required)

"Name":

"STRING",

# Shipping method postage name ( like Royal Mail 1st Class , Parcelforce (2 Day Delivery) , etc )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"PriceExchanged":

"STRING",

# Shipping price exchanged to current site currency

(required)

"Calculated":

"STRING",

# Y/N - is price received from postage service provider ( N - defined directly by user )

(required)

"ShippingTo":

"STRING",

# ISO Country code for this shipping price ( like uk , us, etc )

(required)

"ShippingToName":

"STRING",

# Country Name for this shipping price ( like United States , Canada , etc )

(required)

"ExtraDetails":

"STRING"

# Extar details for this postage method ( Not available or to be calculated ) , can replace price by this text

(required)

}

(required)

# Listing shipping data . Depend from parameters and listing shipping data this tag may include different optional shipping parameters.

(required)

"MinShippingCost":

"STRING",

# Minimal shipping cost for this listing to choosed or default country

(required)

"MinShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"MinShippingCostName":

"STRING",

# Minimal shipping cost postage method ( printable label like "Royal Mail Airmail" ...)

(required)

"UserListingsCount":

INT,

# Listings count for this listing , is optional depend from parameters.

(optional)

"ShipZipRequiredDom":

VALUES SET,

# Y/(empty value) , is zip postacode required to calculate Domestic shipping prices

(required)

Y=Yes | =No (empty value)

"ShipZipRequiredInt":

VALUES SET,

# Y/(empty value) is zip/postcode required to calculate international price

(required)

Y=Yes | =No (empty value)

"Bids":

{

"Bid":

[{

"BidID":

INT,

# Bid ID

(required)

"BuyNow":

VALUES SET,

# Y/(empty value) - is this buynow bid record

(required)

Y=Yes | =No (empty value)

"UserID":

INT,

# Bidder UserID ( possible 0 - when name hidden , adult listings)

(required)

"Username":

"STRING",

# Bidder username

(required)

"UnixTime":

"STRING",

# Unix Timestamp when bid made

(required)

"Amount":

"STRING",

# Bid amount , possible value "Not Public" for non public values

(required)

"Allocation":

INT,

# Quandtity allocated by this bid ( for dutch listings possible less then quantity )

(required)

"Quantity":

INT,

# Bid quantity

(required)

"QuantityText":

"STRING",

# Printable bid quantity , use to output

(required)

"Time":

"STRING",

# Printable bid time

(required)

"MAO":

VALUES SET,

# Y/(empty value) - is bid generated by successful offer

(required)

Y=Yes | =No (empty value)

"IconType":

VALUES SET,

# Bid icon type - p, r, b ( proxy , reserve meet , buynow )

(required)

p=Proxy | r=Reserve meet | b=Buynow

"IconImages":

"STRING",

# Icon images tags , include IMG tage , possible few together.

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Bidder user object , may not be here if private listing , or can be full version if some params present.

(optional)

"HiddenName":

VALUES SET,

# Y/(empty value) - is name hidden

(required)

Y=Yes | =No (empty value)

"NotPublic":

VALUES SET,

# Y/(empty value) - is amount public or no

(required)

Y=Yes | =No (empty value)

"BuyerFullInfo":

VALUES SET

# Y/(empty value) - is User tag include full version of user object

(required)

Y=Yes | =No (empty value)

}]

(required)

# Bids history for this listing , only if it required in initial query , or empty value

(required)

"Type":

VALUES SET,

# "n" or "d" char , Listing type n-single item listing , d - multi item listing

(required)

n=Single item listing | d=Multi item listing

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing/listing price

(required)

"AdultHiddenName":

[{

"UserID":

INT,

# UserID

(required)

"Username":

"STRING"

# Hidden name replacement like "hiddenname1"

(required)

}],

(required)

"AdultHide":

"STRING",

# Y/N value - is listing opted as Adult Hide Usernames

(required)

"ItemsAvailableBid":

INT,

# Quantity available to bid . If holiday notice set - bidding is not available .

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empy value) - is bidding available for this listing now . Do not show bid form if this field is not set to Y.

(required)

Y=Yes | =No (empty value)

"HolidayNotice":

VALUES SET,

# Y/N value . Is User notice is holiday ( user is on vacancy , and bidding not available )

(required)

Y=yes | N=No

"HolidayNoticeText":

"STRING",

# Holiday notice text , If notify is present then user text or empty.

(required)

"Watch":

VALUES SET,

# Y/N value , is current user watching this listing , only if login info sent with request .

(required)

Y=yes | N=No

"ListingStateSuccess":

VALUES SET,

# Y/N value , is this listing for current user is success ( high bidder , buyed via buynow ) , empty value if user login info not sent with query

(required)

Y=yes | N=No

"ListingStateMessage":

"STRING",

# Listing status message normally shown on eBid listing page at top , only for logged in users ( if login info sent with query )

(required)

"ListingQuestionState":

"STRING",

# Listing question state , only if login data sent with this query e.q. for logged info only . Or empty.

(required)

"Live":

VALUES SET,

# Y/(empty value) - is listing live , e.q. running . listing is live while it not moved to myeBid closed area ( not just time expired ).

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/N value - Is seller accept offers for this listing .

(required)

Y=yes | N=No

"OffersStatus":

"STRING",

# Offers status normally shown at top of eBid listing page , is not empty if seller accept offers , some offer made , and user logged in ( logged info sent with query )

(required)

"OffersAttentionRequired":

VALUES SET,

# Y/N value , is current offers required logged user attention . For example seller attention required when offers made . Is set only if logged user info provided with query.

(required)

Y=yes | N=No

"OffersHistoryCount":

INT,

# How many offers made for this listing/listing

(required)

"PrimaryMarket":

VALUES SET,

# Primary market ISO country code like "us" , "uk" , "eu" ...

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list like "us,uk,eu" or similar . Listing is available on these eBid markets .

(required)

"ASL":

[{

"Sale":

{

"SaleID":

INT,

# Sale ID

(required)

"Buyer":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Buyer info

(required)

"UnixTime":

INT,

# Unix Timestamp when sale made

(required)

"Time":

"STRING",

# Printable when sale made

(required)

"PurchasePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price

(required)

"PurchasePriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price exchanged to current country currency

(required)

"Quantity":

INT,

# Quantity of items purchased

(required)

"ShippingPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"ShippingPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price exchanged to current country currency

(required)

"TotalAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Total sale amount

(required)

"TotalAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total Amount exchanged to current country currency

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

}

# Items Seller object

(required)

"Status":

{

"InvoiceStatus":

VALUES SET,

# Y/N value is invoice sent

(required)

Y=yes | N=No

"InvoiceStatusText":

"STRING",

# is invoice sent - Yes/No text status

(required)

"PaymentStatus":

VALUES SET,

# C/R/NP/Y/YN/N values where C - Cancelled, R - Refunded, NP - Non Payed , Y - Payed, YN - Pending , N - Not Yet

(required)

"PaymentStatusText":

"STRING",

# Payment status printable text - Cancelled / Refunded / Non Payed / Payed / Pending / Not Yet

(required)

"ShipmentStatus":

VALUES SET,

# Y/N/C - is item shipped - yes , no , cancelled

(required)

Y=Shipped | N=Not Shipped | C=Cancelled

"ShipmentStatusText":

"STRING",

# text value for shipment status - Yes / No / Cancelled

(required)

"FeedbackLeftStatus":

VALUES SET,

# Is feedback left by current user - Y/N/C - Yes, No , Cancelled

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackLeftStatusText":

"STRING",

# Is feedback leaved by current user - Yes / No / Cancelled

(required)

"FeedbackReceivedStatus":

VALUES SET,

# Y/N/C - is current user received feedback for this item ( Yes / No / Cancelled )

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackReceivedStatusText":

"STRING"

# printable feedback received for this item status - Yes / No / Cancelled

(required)

"AvailableOptions":

{

"Option":

[{

"ID":

INT,

# ASL option ID

(required)

"Code":

VALUES SET,

# ASL string code like (PayNowViaPPPay, RequestInvoiceFromSeller ...) , use this to make all checks in code.

(required)

"Text":

"STRING",

# Option title ( use to show on screen as choose option )

(required)

"ExtraParam":

"STRING",

# Some extra params for option , currently used only for question reply and include question ID .

(required)

"TextNeed":

VALUES SET

(required)

Y=user required enter text | N=text is not need | C=option cannot be submit

}]

(required)

# Available after sale actions

(required)

"Log":

{

"Message":

[{

"ID":

INT,

# ASL log entry ID

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# ASL log user ( who logged )

(required)

"UnixTime":

INT,

# Unix timestamp when entry added

(required)

"Time":

"STRING",

# Printable time when log entry added

(required)

"Type":

VALUES SET,

# A numeric value relating to the type of ASL entry.

(required)

"TextType":

"STRING",

# Log entry type ( printable text )

(required)

"Details":

"STRING",

# Log entry message ( entered by user or generated )

(required)

"ReplyTo":

INT,

# ReplyID to some other log entry ( only for questions replies )

(required)

"NudgeCount":

INT,

# Nudge count ( questions only )

(required)

"LastNudgeUnixTime":

INT,

# Unix Timestamp of last nudge ( questions only )

(required)

"LastNudge":

"STRING",

# Last nudge time ( printable format )

(required)

"FeedbackMessage":

"STRING"

# Feedback message ( only for feedbacks )

(required)

}]

(required)

# ASL Log entry

(required)

}],

(required)

"ReservePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing reserve price .

(required)

"AutoOfferAcceptPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers auto accept price

(required)

"AutoOfferDeclinePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers Auto decline price

(required)

"ToRepostCount":

INT,

# Count of autoreposts still due for this listing

(required)

"ToRepostOriginalCount":

INT,

# Initial value of count of listing autoreposts

(required)

"BuynowDiscount":

DECIMAL,

# Current buynow discount rate , is percent from 0 to 99.9

(required)

"ItemSpecificRaw":

"STRING",

# Item specific string , color , sizes , etc . Same format as for bulk upload .

(required)

"Duration":

{

"Days":

INT,

# Days

(required)

"Hours":

INT,

# Hours , available to Seller+ accounts only

(required)

"Mins":

INT,

# Mins , available for Seller+ accounts only

(required)

"UntilSold":

VALUES SET,

# Y/(empty value ) is this listing is Run Until Sold , if so then Days/Hours/Mins is empty

(required)

Y=Yes | =No (empty value)

"AutoExtend":

VALUES SET

# Y/N value , is listing auto extended when busy bids made.

(required)

Y=yes | N=No

# Original listing duration

(required)

"StartListing":

{

"Type":

VALUES SET

# Listing start options : "immediately" , "onfirstbid"

(required)

immediate=Immediate | onfirstbid=On firts bid | custom=Custom time

# Listing start information

(required)

"Tax":

[{

"State":

"STRING",

# Tax state code ( like NY, FL etc )

(required)

"Rate":

DECIMAL,

# Tax rate ( percent )

(required)

"ApplyToShipping":

VALUES SET

# Y/(empty value) - is tax applied to shipping also

(required)

Y=Yes | =No (empty value)

}],

(required)

"URL":

"STRING",

# Listing URL pointed to eBid listing page

(required)

"QuestionsCount":

INT,

# Questions count or empty value. Questions count provided only with options "QuestionsCount=Y" or "QuestionsHistory=Y"

(required)

"Questions":

{

"QuestionID":

INT,

# Question ID

(required)

"ListingID":

INT,

# Listing ID

(required)

"Poster":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Question poster ( user object )

(required)

"UnixTime":

INT,

# Unixtimestamp time when question/reply posted

(required)

"Time":

"STRING",

# Printable question/reply time

(required)

"Message":

"STRING",

# Question/Reply text

(required)

"ReplyToID":

INT,

# ID of question replied or empty if is not reply

(required)

"NudgeCount":

INT,

# Nudge count ( how many times user nudged question )

(required)

"LastNudgeUnixTime":

INT,

# Unix timestamp when question last nudged

(required)

"LastNudgeTime":

"STRING"

# Printable time when question last time nudged

(required)

# Is quertion history only if option "QuestionsHistory=Y"

(required)

"DispatchTime":

{

"Code":

VALUES SET,

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(required)

"Label":

"STRING"

# Dispatch time information ( text ) as shown on eBid Listing pages

(required)

# Item dispatch time information

(required)

"ReturnPolicy":

{

"Code":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(required)

"Label":

"STRING"

# Return policy text

(required)

# Return policy information

(required)

"CategoryPath":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# opted by option "FullCategoryPath=Y"

(required)

"CategoryPath2":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# Category path for second category , if category present and query opted with 'FullCategoryPath=Y'

(required)

"RepostedIDs":

"STRING",

# If listing is closed and in request option RepostedIDs=Y was set , then it return comma separated list of ids of listings reposted from this one . Most recently reposted is first in the list .

(optional)

"Variations":

{

"ImageTag":

"STRING",

# Variation image tag

(required)

[

"Variation":

{

"Image":

{

"ImageLarge":

"STRING",

# Big image URL

(required)

"ImageSmall":

"STRING",

# Small image URL

(required)

"ImageMedium":

"STRING",

# Medium image URL

(required)

"eBidImage":

VALUES SET

# Is image stored at eBid servers ? Y/N

(required)

Y=yes | N=No

# Image info

(optional)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Variation price

(required)

"Quantity":

INT,

# Items quantity

(required)

"QuantitySold":

INT,

# Quantity already Sold

(required)

"Barcode":

"STRING",

# UPC/EAN/MPN code

(required)

"ItemSpecifics":

{

"Name":

"STRING",

# Attribute name

(required)

"Value":

"STRING"

# Attribute value

(required)

# Variation specifics

(required)

]

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING",

# Variation Maximum Price (added in 2.0)

(required)

"ItemSpecifics":

[{

"Name":

"STRING",

# Tag name

(required)

"Value":

"STRING"

# Tag value

(required)

}]

(required)

}

LOGIN Methods
eBid API methods to allow a user login session to be created. A Session ID is required first then a login can take place via redirecting your user to the LoginURL returned.

CheckLoginKey
Is the current "LoginKey" still valid and not expired? Eg. is the user still logged in?

GetLoginKey
This method returns a "LoginKey" based on the "SessionID" sent in the request. It's the last pasrt of the authorization process. The "LoginKey" must be stored securely at the client side and added to any relevant requests that require a login to process. It cannot be requested twice.

API Command: GetLoginKey
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetLoginKey" ,

"SessionID":

"STRING"

# Session id retrieved in GetSessionID function

(required)

}

RESPONSE

{
"APIVersion": "",

"LoginKey":

"STRING",

# Login key ID , is 32 char length

(required)

"Expiry":

INT,

# Key expire time

(required)

"ReturnURL":

"STRING",

# Return URL to your site/app ( 'ok' URL )

(required)

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

}

GetSessionID
SessionID is a 32 character random string generated by the API. A success ("ReturnURL") and failed/cancelled ("RetunCancelURL") are required to redirect after a good/bad login.

MY EBID Methods
eBid API methods relating to user account administration similar to the "My eBid" section of the eBid website.

GetMyEbidBidsMade
Returns an array of listings on which the current user has pending bids. This will not include bids that won auctions.

API Command: GetMyEbidBidsMade
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetMyEbidBidsMade" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"Start":

INT,

# Bids made table offset , for pagenavigation

(optional)

"RowsLimit":

INT

# Number of listings in response . Max 75 .

(optional)

}

RESPONSE

{
"APIVersion": "",

"TotalItemsCount":

INT,

# Total items in myeBid bids on section

(required)

"ListItem":

[{

"ListingID":

INT,

# Listing ID

(required)

"Title":

"STRING",

# Listing title

(required)

"BidCount":

INT,

# Bids count ( include BuyNow bids )

(required)

"Currency":

"STRING",

# Listing currency code , like USD , GBP , EUR

(required)

"BuyNowAvailable":

INT,

# Quantity of items available for BuyNow option

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow pprice exchanged to current site currency

(required)

"PrimaryMarket":

"STRING",

# Listing primary market , ISO code like 'us' , 'uk'

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current price exchanged to current site currency

(required)

"Quantity":

INT,

# Listing Quantity ( all items offered by this listing )

(required)

"Views":

INT,

# Current listing page views

(required)

"ShippingCost":

"STRING",

# Lowest postage price

(required)

"ShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Category information

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Seller information

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image ( large version )

(required)

"PrimaryImageSmall":

"STRING",

# URL to primary image ( small version )

(required)

"PrimaryImageMedium":

"STRING",

# Primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N value is main image stored on eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N value is main image is part of UPC/EAN image library

(required)

"ItemsAvailableBid":

INT,

# Items count available to bid

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empty value ) is bidding available for this listing

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/(empty value) is seller accept offers for this item

(required)

Y=Yes | =No (empty value)

"AvailableTo":

VALUES SET,

# Comma separated countries like "us,uk,eu" or similar for which this listing is available

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"tick":

VALUES SET,

# Y/N value , Is this listing is success for current user ( if login info sent with query )

(optional)

Y=yes | N=No

"Winner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Current winner of listing ( if there is )

(optional)

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Listing price , is optional if user logged in

(optional)

"CurrentPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing price , is present only user logged in ( login information sent with query )

(optional)

"UnixTimeEnd":

INT,

# Listing end time , is unix timestamp or special value , 2000000000 = Run Until Sold , 2000000001 - 1 day after 1st bid , 2000000002 - 2 days after 1st bid , etc

(required)

"TimeEnd":

"STRING",

# Listing end time in printable format

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"URL":

"STRING",

# URL to listing page on eBid main site

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING"

# Variation Max Price (added in 2.0)

(required)

}]

(required)

}

GetMyEbidBidsReceived
Returns and array of listings on which the user has received bids on items they are selling. Bids will be pending, eg. auction has not closed yet.

API Command: GetMyEbidBidsReceived
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetMyEbidBidsReceived" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"Start":

INT,

# Offset to listings table . First item in response .

(optional)

"RowsLimit":

INT

# Number of items in response . Max 75.

(optional)

}

RESPONSE

{
"APIVersion": "",

"TotalItemsCount":

INT,

# Items count in my eBid bids received

(required)

"ListItem":

[{

"ListingID":

INT,

# Listing ID

(required)

"Title":

"STRING",

# Listing title

(required)

"BidCount":

INT,

# Bids count ( include BuyNow bids )

(required)

"Currency":

"STRING",

# Listing currency code , like USD , GBP , EUR

(required)

"BuyNowAvailable":

INT,

# Quantity of items available for BuyNow option

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow pprice exchanged to current site currency

(required)

"PrimaryMarket":

"STRING",

# Listing primary market , ISO code like 'us' , 'uk'

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current price exchanged to current site currency

(required)

"Quantity":

INT,

# Listing Quantity ( all items offered by this listing )

(required)

"Views":

INT,

# Current listing page views

(required)

"ShippingCost":

"STRING",

# Lowest postage price

(required)

"ShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Category information

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Seller information

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image ( large version )

(required)

"PrimaryImageSmall":

"STRING",

# URL to primary image ( small version )

(required)

"PrimaryImageMedium":

"STRING",

# Primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N value is main image stored on eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N value is main image is part of UPC/EAN image library

(required)

"ItemsAvailableBid":

INT,

# Items count available to bid

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empty value ) is bidding available for this listing

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/(empty value) is seller accept offers for this item

(required)

Y=Yes | =No (empty value)

"AvailableTo":

VALUES SET,

# Comma separated countries like "us,uk,eu" or similar for which this listing is available

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"tick":

VALUES SET,

# Y/N value , Is this listing is success for current user ( if login info sent with query )

(optional)

Y=yes | N=No

"Winner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Current winner of listing ( if there is )

(optional)

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Listing price , is optional if user logged in

(optional)

"CurrentPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing price , is present only user logged in ( login information sent with query )

(optional)

"UnixTimeEnd":

INT,

# Listing end time , is unix timestamp or special value , 2000000000 = Run Until Sold , 2000000001 - 1 day after 1st bid , 2000000002 - 2 days after 1st bid , etc

(required)

"TimeEnd":

"STRING",

# Listing end time in printable format

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"URL":

"STRING",

# URL to listing page on eBid main site

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING"

# Variation Max Price (added in 2.0)

(required)

}]

(required)

}

GetMyEbidBought
Returns an array of listings which have resulted in purchases by this user. Be it BuyNow, successful bids or accepted MaO (offers).

API Command: GetMyEbidBought
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetMyEbidBought" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"Start":

INT,

# Offset to listings table . First item in response .

(optional)

"RowsLimit":

INT,

# Number of items in response . Max 75.

(optional)

"ShortResponse":

"STRING"

# Y/(empty value) - if Y - then return in very short information format

(optional)

}

RESPONSE

{
"APIVersion": "",

"TotalItemsCount":

INT,

# Total items in my eBid bought section

(required)

"Bought":

[{

"ListItem":

{

"ListingID":

INT,

# Listing ID

(required)

"Title":

"STRING",

# Listing title

(required)

"BidCount":

INT,

# Bids count ( include BuyNow bids )

(required)

"Currency":

"STRING",

# Listing currency code , like USD , GBP , EUR

(required)

"BuyNowAvailable":

INT,

# Quantity of items available for BuyNow option

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow pprice exchanged to current site currency

(required)

"PrimaryMarket":

"STRING",

# Listing primary market , ISO code like 'us' , 'uk'

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current price exchanged to current site currency

(required)

"Quantity":

INT,

# Listing Quantity ( all items offered by this listing )

(required)

"Views":

INT,

# Current listing page views

(required)

"ShippingCost":

"STRING",

# Lowest postage price

(required)

"ShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Category information

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Seller information

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image ( large version )

(required)

"PrimaryImageSmall":

"STRING",

# URL to primary image ( small version )

(required)

"PrimaryImageMedium":

"STRING",

# Primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N value is main image stored on eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N value is main image is part of UPC/EAN image library

(required)

"ItemsAvailableBid":

INT,

# Items count available to bid

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empty value ) is bidding available for this listing

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/(empty value) is seller accept offers for this item

(required)

Y=Yes | =No (empty value)

"AvailableTo":

VALUES SET,

# Comma separated countries like "us,uk,eu" or similar for which this listing is available

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"tick":

VALUES SET,

# Y/N value , Is this listing is success for current user ( if login info sent with query )

(optional)

Y=yes | N=No

"Winner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Current winner of listing ( if there is )

(optional)

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Listing price , is optional if user logged in

(optional)

"CurrentPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing price , is present only user logged in ( login information sent with query )

(optional)

"UnixTimeEnd":

INT,

# Listing end time , is unix timestamp or special value , 2000000000 = Run Until Sold , 2000000001 - 1 day after 1st bid , 2000000002 - 2 days after 1st bid , etc

(required)

"TimeEnd":

"STRING",

# Listing end time in printable format

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"URL":

"STRING",

# URL to listing page on eBid main site

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING"

# Variation Max Price (added in 2.0)

(required)

"UnixTime":

INT,

# UnixTimestamp when sale record added ( sale done )

(required)

"Time":

"STRING",

# Printable time when sale done

(required)

"PurchasePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item price

(required)

"PurchasePriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item price exchanged to current site currency

(required)

"Quantity":

INT,

# Quentity sold ( 0 - sale cancelled )

(required)

"ShippingPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"ShippingPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price exchanged to current site currency

(required)

"TotalAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total amount

(required)

"TotalAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total amount exchanged to current site currency

(required)

"InvoiceStatus":

VALUES SET,

# Y/N value - is invoice sent

(required)

Y=yes | N=No

"InvoiceStatusText":

"STRING",

# Printable text ( Yes/No ) is invoice sent

(required)

"PaymentStatus":

VALUES SET,

# C/R/NP/Y/YN/N values where C - Cancelled, R - Refunded, NP - Non Payed , Y - Payed, YN - Pending , N - Not Yet

(required)

"PaymentStatusText":

"STRING",

# Payment status printable text - Cancelled / Refunded / Non Payed / Payed / Pending / Not Yet

(required)

"ShipmentStatus":

VALUES SET,

# Y/N/C - is item shipped - yes , no , cancelled

(required)

Y=Shipped | N=Not Shipped | C=Cancelled

"ShipmentStatusText":

"STRING",

# text value for shipment status - Yes / No / Cancelled

(required)

"FeedbackLeftStatus":

VALUES SET,

# Is feedback left by current user - Y/N/C - Yes, No , Cancelled

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackLeftStatusText":

"STRING",

# Is feedback leaved by current user - Yes / No / Cancelled

(required)

"FeedbackReceivedStatus":

VALUES SET,

# Y/N/C - is current user received feedback for this item ( Yes / No / Cancelled )

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackReceivedStatusText":

"STRING",

# printable feedback received for this item status - Yes / No / Cancelled

(required)

"SaleID":

INT,

# ID of sale record

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

}

# Seller info

(required)

}]

(required)

}

GetMyEbidCounters
Returns the most important counts relating to a user's activity. Includes number of bids made, items purchased, offers made, offers received, sold items etc. Similar to the My eBid Dashboard counts on our main site.

GetMyEbidOffersMade
Returns an array of listings on which the current user has pending offers (MaO). This will not include offers that were accepted by the seller and changed into purchased items.

API Command: GetMyEbidOffersMade
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetMyEbidOffersMade" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"Start":

INT,

# Offset to listings table . First item in response .

(required)

"RowsLimit":

INT

# Number of items in response . Max 75.

(required)

}

RESPONSE

{
"APIVersion": "",

"TotalItemsCount":

INT,

# Total items in myebid offers made

(required)

"Offer":

[{

"ListItem":

{

"ListingID":

INT,

# Listing ID

(required)

"Title":

"STRING",

# Listing title

(required)

"BidCount":

INT,

# Bids count ( include BuyNow bids )

(required)

"Currency":

"STRING",

# Listing currency code , like USD , GBP , EUR

(required)

"BuyNowAvailable":

INT,

# Quantity of items available for BuyNow option

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow pprice exchanged to current site currency

(required)

"PrimaryMarket":

"STRING",

# Listing primary market , ISO code like 'us' , 'uk'

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current price exchanged to current site currency

(required)

"Quantity":

INT,

# Listing Quantity ( all items offered by this listing )

(required)

"Views":

INT,

# Current listing page views

(required)

"ShippingCost":

"STRING",

# Lowest postage price

(required)

"ShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Category information

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Seller information

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image ( large version )

(required)

"PrimaryImageSmall":

"STRING",

# URL to primary image ( small version )

(required)

"PrimaryImageMedium":

"STRING",

# Primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N value is main image stored on eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N value is main image is part of UPC/EAN image library

(required)

"ItemsAvailableBid":

INT,

# Items count available to bid

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empty value ) is bidding available for this listing

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/(empty value) is seller accept offers for this item

(required)

Y=Yes | =No (empty value)

"AvailableTo":

VALUES SET,

# Comma separated countries like "us,uk,eu" or similar for which this listing is available

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"tick":

VALUES SET,

# Y/N value , Is this listing is success for current user ( if login info sent with query )

(optional)

Y=yes | N=No

"Winner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Current winner of listing ( if there is )

(optional)

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Listing price , is optional if user logged in

(optional)

"CurrentPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing price , is present only user logged in ( login information sent with query )

(optional)

"UnixTimeEnd":

INT,

# Listing end time , is unix timestamp or special value , 2000000000 = Run Until Sold , 2000000001 - 1 day after 1st bid , 2000000002 - 2 days after 1st bid , etc

(required)

"TimeEnd":

"STRING",

# Listing end time in printable format

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"URL":

"STRING",

# URL to listing page on eBid main site

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING"

# Variation Max Price (added in 2.0)

(required)

"OfferID":

INT,

# This offer ID

(required)

"UnixTime":

"STRING",

# Unix timestamp when offer made

(required)

"Time":

"STRING",

# Printable time when offer made

(required)

"OfferAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# This offer amount

(required)

"OfferAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offer amount exchanged to current country currency

(required)

"Quantity":

INT,

# Offer Quantity

(required)

"CounterOfferUnixTime":

INT,

# Counter offer unix timestamp or zero if no counter offer made

(required)

"CounterOfferTime":

"STRING",

# Printable time when counter offer made or empty if no counter offer

(required)

"CounterOfferAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Counter offer amount

(required)

"CounterOfferAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Counter offer amount exchanged to current site currency

(required)

"StateUnixTime":

"STRING",

# Current status unix timestamp ( when last changed )

(required)

"StateTime":

"STRING",

# Current status printable time ( when last changed )

(required)

"StateCode":

VALUES SET,

# Current status code

(required)

"StateText":

"STRING",

# Current status printable text like ( New , countered , etc )

(required)

"BuyerNote":

"STRING",

# Offer buyer note

(required)

"SellerNote":

"STRING",

# Offer seller note

(required)

"OfferMadeBy":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Buyer info who made this offer

(required)

"OfferExtraState":

VALUES SET,

# Special state code , ATTN / WAIT

(required)

ATTN=Attention required | WAIT=Wait for other side | Y=Offer successful | N=Offer is not successful

"DecideUnixTime":

"STRING",

# Max time ( unix timestamp ) when need decide about this offer or counter offer

(required)

"DecideTime":

"STRING"

# Max time ( printable version ) when need decide about this offer or counter offer

(required)

}]

(required)

}

GetMyEbidOffersReceived
Returns an array of listings on which the current user has pending offers (MaO) received. This will not include offers that were accepted by this user and therefore changed into sold items.

API Command: GetMyEbidOffersReceived
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetMyEbidOffersReceived" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"Start":

INT,

# Offset to listings table . First item in response .

(optional)

"RowsLimit":

INT

# Number of items in response . Max 75.

(optional)

}

RESPONSE

{
"APIVersion": "",

"Listing":

{

"ListingID":

INT,

# Listing ID

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Listing Seller data

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Listing category

(required)

"Category2":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Second category , if present or empty tag is not

(optional)

"Title":

"STRING",

# Listing title

(required)

"SubTitle":

"STRING",

# Listing subtitle ( if present )

(required)

"Bold":

VALUES SET,

# Y/N value , is listing bold

(required)

Y=yes | N=No

"Highlight":

VALUES SET,

# Y/N value , is listing highlighten in listings

(required)

Y=yes | N=No

"Movie":

"STRING",

# Listing movie ID

(required)

"Brand":

"STRING",

# Listing brand

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image large version ( or empty )

(required)

"PrimaryImageSmall":

"STRING",

# URL to Listing primary image small version or empty

(required)

"PrimaryImageMedium":

"STRING",

# URL to Listing primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N - Is image uploaded to eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N , is image is part of UPC/EAN library

(required)

"Quantity":

INT,

# Listing quantity ( 1 - max value )

(required)

"StartTime":

"STRING",

# Listing start time printable version

(required)

"StartTimeUnix":

INT,

# Start time , Unixtimestamp

(required)

"StartPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing Start price value

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"NextBid":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Next prossible bid or empty if not applicable

(required)

"Increment":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Increment value

(required)

"BidCount":

INT,

# Count of bids already made

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"BuyNowAvailable":

INT,

# Items quantity available for BuyNow

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price for this Listing

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price exchanged to local currency ( current country view )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price exchanged to current country currency

(required)

"Views":

INT,

# Listing views count ( how many it was viewed on eBid )

(required)

"Description":

"STRING",

# Listing Description

(required)

"Store":

{

"StoreID":

INT,

# Store ID

(required)

"Owner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Store owner

(required)

"Title":

"STRING",

# Store title ( name )

(required)

"Description":

"STRING",

# Store description

(required)

"Category":

INT,

# Store classification category ID ( ebid categories )

(required)

"Image":

"STRING",

# URL of store banner image

(required)

"ListingsCount":

INT,

# Count of listings in this store

(required)

"Link":

"STRING",

# URL to store ( link to eBid )

(required)

"Online":

VALUES SET

# Y/N value is store online

(required)

Y=yes | N=No

# Listing Store

(required)

"StoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Store category where listing listed ( or empty if not in store )

(required)

"ParentStoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Parent Store category where it listed or empty value

(required)

"AutoExtended":

VALUES SET,

# Y/N value , is autoextend set for Listing

(required)

Y=yes | N=No

"Barcode":

"STRING",

# UPC/EAN barcode code or empty value , or special value "EXEMPT"

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"ItemCondition":

{

"ID":

VALUES SET,

# Item condition id , n - new , u - used , s - unused , r - refurbished , '' - any

(required)

n=New | u=Used | s=Unused | r=Refurbished | =Any

"Name":

"STRING",

# Printable name of option

(required)

"APIName":

"STRING"

# API name to refer for API ( NEW , USED, UNUSED, REFURBISHED, ANY )

(required)

# Listing item condition

(required)

"PaymentOptions":

{

"PaymentOption":

[{

"ID":

INT,

# Option ID

(required)

"Name":

"STRING"

# Option name

(required)

}]

(required)

# Payment options available for listing

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"ShipTo":

VALUES SET,

# ISO country code for which current shipping price calculated

(required)

"ShipToName":

"STRING",

# Country name to which current shipping prices calculated

(required)

"ShipToZip":

"STRING",

# zip/postcode to which current shipping price calculated ( if required or present ).

(required)

"Shippings":

{

"DomesticShippings":

{

"Type":

"STRING",

# constant - "calculated"

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions (cm , or inch)

(required)

"Weight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Package weight ( for some countries is kg and gramms )

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

"STRING",

# Package girth ( inch )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Fedex package options or empty values

(optional)

}],

(required)

"PackageName":

"STRING"

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"DomesticShippings":

{

"Type":

"STRING",

# "flat" - is hardcoded , can be used to indefiny shipping type

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL

# Extra item shipping price ( if different then 1st item shipping price and if multi item listing )

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# shipping object type , hardcoded value "calculated"

(required)

"Handling":

DECIMAL,

# handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions ( in cm or inch depend from country )

(required)

"Weight":

{

"Lbs":

"STRING",

(required)

"Oz":

"STRING"

(required)

# Package weigh lb & oz or kg and gramms depend from country

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"PackageName":

"STRING",

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

DECIMAL,

# Package girth ( if applicable )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Options filled only if package is fedex

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# postage type , hardcoded value "flat"

(required)

"Option":

[{

"ShippingService":

"STRING",

# Postage service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL,

# Extra item shipping price ( if quantity more then 1 and shipping price is different then 1st item )

(required)

"AvailableTo":

VALUES SET

# Comma separated ISO country lists to which this shipping possible ( like "uk,us,de" )

(required)

}]

(required)

"Shipping":

{

"Code":

"STRING",

# Shipping method eBid code

(required)

"Name":

"STRING",

# Shipping method postage name ( like Royal Mail 1st Class , Parcelforce (2 Day Delivery) , etc )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"PriceExchanged":

"STRING",

# Shipping price exchanged to current site currency

(required)

"Calculated":

"STRING",

# Y/N - is price received from postage service provider ( N - defined directly by user )

(required)

"ShippingTo":

"STRING",

# ISO Country code for this shipping price ( like uk , us, etc )

(required)

"ShippingToName":

"STRING",

# Country Name for this shipping price ( like United States , Canada , etc )

(required)

"ExtraDetails":

"STRING"

# Extar details for this postage method ( Not available or to be calculated ) , can replace price by this text

(required)

}

(required)

# Listing shipping data . Depend from parameters and listing shipping data this tag may include different optional shipping parameters.

(required)

"MinShippingCost":

"STRING",

# Minimal shipping cost for this listing to choosed or default country

(required)

"MinShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"MinShippingCostName":

"STRING",

# Minimal shipping cost postage method ( printable label like "Royal Mail Airmail" ...)

(required)

"UserListingsCount":

INT,

# Listings count for this listing , is optional depend from parameters.

(optional)

"ShipZipRequiredDom":

VALUES SET,

# Y/(empty value) , is zip postacode required to calculate Domestic shipping prices

(required)

Y=Yes | =No (empty value)

"ShipZipRequiredInt":

VALUES SET,

# Y/(empty value) is zip/postcode required to calculate international price

(required)

Y=Yes | =No (empty value)

"Bids":

{

"Bid":

[{

"BidID":

INT,

# Bid ID

(required)

"BuyNow":

VALUES SET,

# Y/(empty value) - is this buynow bid record

(required)

Y=Yes | =No (empty value)

"UserID":

INT,

# Bidder UserID ( possible 0 - when name hidden , adult listings)

(required)

"Username":

"STRING",

# Bidder username

(required)

"UnixTime":

"STRING",

# Unix Timestamp when bid made

(required)

"Amount":

"STRING",

# Bid amount , possible value "Not Public" for non public values

(required)

"Allocation":

INT,

# Quandtity allocated by this bid ( for dutch listings possible less then quantity )

(required)

"Quantity":

INT,

# Bid quantity

(required)

"QuantityText":

"STRING",

# Printable bid quantity , use to output

(required)

"Time":

"STRING",

# Printable bid time

(required)

"MAO":

VALUES SET,

# Y/(empty value) - is bid generated by successful offer

(required)

Y=Yes | =No (empty value)

"IconType":

VALUES SET,

# Bid icon type - p, r, b ( proxy , reserve meet , buynow )

(required)

p=Proxy | r=Reserve meet | b=Buynow

"IconImages":

"STRING",

# Icon images tags , include IMG tage , possible few together.

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Bidder user object , may not be here if private listing , or can be full version if some params present.

(optional)

"HiddenName":

VALUES SET,

# Y/(empty value) - is name hidden

(required)

Y=Yes | =No (empty value)

"NotPublic":

VALUES SET,

# Y/(empty value) - is amount public or no

(required)

Y=Yes | =No (empty value)

"BuyerFullInfo":

VALUES SET

# Y/(empty value) - is User tag include full version of user object

(required)

Y=Yes | =No (empty value)

}]

(required)

# Bids history for this listing , only if it required in initial query , or empty value

(required)

"Type":

VALUES SET,

# "n" or "d" char , Listing type n-single item listing , d - multi item listing

(required)

n=Single item listing | d=Multi item listing

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing/listing price

(required)

"AdultHiddenName":

[{

"UserID":

INT,

# UserID

(required)

"Username":

"STRING"

# Hidden name replacement like "hiddenname1"

(required)

}],

(required)

"AdultHide":

"STRING",

# Y/N value - is listing opted as Adult Hide Usernames

(required)

"ItemsAvailableBid":

INT,

# Quantity available to bid . If holiday notice set - bidding is not available .

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empy value) - is bidding available for this listing now . Do not show bid form if this field is not set to Y.

(required)

Y=Yes | =No (empty value)

"HolidayNotice":

VALUES SET,

# Y/N value . Is User notice is holiday ( user is on vacancy , and bidding not available )

(required)

Y=yes | N=No

"HolidayNoticeText":

"STRING",

# Holiday notice text , If notify is present then user text or empty.

(required)

"Watch":

VALUES SET,

# Y/N value , is current user watching this listing , only if login info sent with request .

(required)

Y=yes | N=No

"ListingStateSuccess":

VALUES SET,

# Y/N value , is this listing for current user is success ( high bidder , buyed via buynow ) , empty value if user login info not sent with query

(required)

Y=yes | N=No

"ListingStateMessage":

"STRING",

# Listing status message normally shown on eBid listing page at top , only for logged in users ( if login info sent with query )

(required)

"ListingQuestionState":

"STRING",

# Listing question state , only if login data sent with this query e.q. for logged info only . Or empty.

(required)

"Live":

VALUES SET,

# Y/(empty value) - is listing live , e.q. running . listing is live while it not moved to myeBid closed area ( not just time expired ).

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/N value - Is seller accept offers for this listing .

(required)

Y=yes | N=No

"OffersStatus":

"STRING",

# Offers status normally shown at top of eBid listing page , is not empty if seller accept offers , some offer made , and user logged in ( logged info sent with query )

(required)

"OffersAttentionRequired":

VALUES SET,

# Y/N value , is current offers required logged user attention . For example seller attention required when offers made . Is set only if logged user info provided with query.

(required)

Y=yes | N=No

"OffersHistoryCount":

INT,

# How many offers made for this listing/listing

(required)

"PrimaryMarket":

VALUES SET,

# Primary market ISO country code like "us" , "uk" , "eu" ...

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list like "us,uk,eu" or similar . Listing is available on these eBid markets .

(required)

"ASL":

[{

"Sale":

{

"SaleID":

INT,

# Sale ID

(required)

"Buyer":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Buyer info

(required)

"UnixTime":

INT,

# Unix Timestamp when sale made

(required)

"Time":

"STRING",

# Printable when sale made

(required)

"PurchasePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price

(required)

"PurchasePriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price exchanged to current country currency

(required)

"Quantity":

INT,

# Quantity of items purchased

(required)

"ShippingPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"ShippingPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price exchanged to current country currency

(required)

"TotalAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Total sale amount

(required)

"TotalAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total Amount exchanged to current country currency

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

}

# Items Seller object

(required)

"Status":

{

"InvoiceStatus":

VALUES SET,

# Y/N value is invoice sent

(required)

Y=yes | N=No

"InvoiceStatusText":

"STRING",

# is invoice sent - Yes/No text status

(required)

"PaymentStatus":

VALUES SET,

# C/R/NP/Y/YN/N values where C - Cancelled, R - Refunded, NP - Non Payed , Y - Payed, YN - Pending , N - Not Yet

(required)

"PaymentStatusText":

"STRING",

# Payment status printable text - Cancelled / Refunded / Non Payed / Payed / Pending / Not Yet

(required)

"ShipmentStatus":

VALUES SET,

# Y/N/C - is item shipped - yes , no , cancelled

(required)

Y=Shipped | N=Not Shipped | C=Cancelled

"ShipmentStatusText":

"STRING",

# text value for shipment status - Yes / No / Cancelled

(required)

"FeedbackLeftStatus":

VALUES SET,

# Is feedback left by current user - Y/N/C - Yes, No , Cancelled

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackLeftStatusText":

"STRING",

# Is feedback leaved by current user - Yes / No / Cancelled

(required)

"FeedbackReceivedStatus":

VALUES SET,

# Y/N/C - is current user received feedback for this item ( Yes / No / Cancelled )

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackReceivedStatusText":

"STRING"

# printable feedback received for this item status - Yes / No / Cancelled

(required)

"AvailableOptions":

{

"Option":

[{

"ID":

INT,

# ASL option ID

(required)

"Code":

VALUES SET,

# ASL string code like (PayNowViaPPPay, RequestInvoiceFromSeller ...) , use this to make all checks in code.

(required)

"Text":

"STRING",

# Option title ( use to show on screen as choose option )

(required)

"ExtraParam":

"STRING",

# Some extra params for option , currently used only for question reply and include question ID .

(required)

"TextNeed":

VALUES SET

(required)

Y=user required enter text | N=text is not need | C=option cannot be submit

}]

(required)

# Available after sale actions

(required)

"Log":

{

"Message":

[{

"ID":

INT,

# ASL log entry ID

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# ASL log user ( who logged )

(required)

"UnixTime":

INT,

# Unix timestamp when entry added

(required)

"Time":

"STRING",

# Printable time when log entry added

(required)

"Type":

VALUES SET,

# A numeric value relating to the type of ASL entry.

(required)

"TextType":

"STRING",

# Log entry type ( printable text )

(required)

"Details":

"STRING",

# Log entry message ( entered by user or generated )

(required)

"ReplyTo":

INT,

# ReplyID to some other log entry ( only for questions replies )

(required)

"NudgeCount":

INT,

# Nudge count ( questions only )

(required)

"LastNudgeUnixTime":

INT,

# Unix Timestamp of last nudge ( questions only )

(required)

"LastNudge":

"STRING",

# Last nudge time ( printable format )

(required)

"FeedbackMessage":

"STRING"

# Feedback message ( only for feedbacks )

(required)

}]

(required)

# ASL Log entry

(required)

}],

(required)

"ReservePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing reserve price .

(required)

"AutoOfferAcceptPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers auto accept price

(required)

"AutoOfferDeclinePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers Auto decline price

(required)

"ToRepostCount":

INT,

# Count of autoreposts still due for this listing

(required)

"ToRepostOriginalCount":

INT,

# Initial value of count of listing autoreposts

(required)

"BuynowDiscount":

DECIMAL,

# Current buynow discount rate , is percent from 0 to 99.9

(required)

"ItemSpecificRaw":

"STRING",

# Item specific string , color , sizes , etc . Same format as for bulk upload .

(required)

"Duration":

{

"Days":

INT,

# Days

(required)

"Hours":

INT,

# Hours , available to Seller+ accounts only

(required)

"Mins":

INT,

# Mins , available for Seller+ accounts only

(required)

"UntilSold":

VALUES SET,

# Y/(empty value ) is this listing is Run Until Sold , if so then Days/Hours/Mins is empty

(required)

Y=Yes | =No (empty value)

"AutoExtend":

VALUES SET

# Y/N value , is listing auto extended when busy bids made.

(required)

Y=yes | N=No

# Original listing duration

(required)

"StartListing":

{

"Type":

VALUES SET

# Listing start options : "immediately" , "onfirstbid"

(required)

immediate=Immediate | onfirstbid=On firts bid | custom=Custom time

# Listing start information

(required)

"Tax":

[{

"State":

"STRING",

# Tax state code ( like NY, FL etc )

(required)

"Rate":

DECIMAL,

# Tax rate ( percent )

(required)

"ApplyToShipping":

VALUES SET

# Y/(empty value) - is tax applied to shipping also

(required)

Y=Yes | =No (empty value)

}],

(required)

"URL":

"STRING",

# Listing URL pointed to eBid listing page

(required)

"QuestionsCount":

INT,

# Questions count or empty value. Questions count provided only with options "QuestionsCount=Y" or "QuestionsHistory=Y"

(required)

"Questions":

{

"QuestionID":

INT,

# Question ID

(required)

"ListingID":

INT,

# Listing ID

(required)

"Poster":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Question poster ( user object )

(required)

"UnixTime":

INT,

# Unixtimestamp time when question/reply posted

(required)

"Time":

"STRING",

# Printable question/reply time

(required)

"Message":

"STRING",

# Question/Reply text

(required)

"ReplyToID":

INT,

# ID of question replied or empty if is not reply

(required)

"NudgeCount":

INT,

# Nudge count ( how many times user nudged question )

(required)

"LastNudgeUnixTime":

INT,

# Unix timestamp when question last nudged

(required)

"LastNudgeTime":

"STRING"

# Printable time when question last time nudged

(required)

# Is quertion history only if option "QuestionsHistory=Y"

(required)

"DispatchTime":

{

"Code":

VALUES SET,

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(required)

"Label":

"STRING"

# Dispatch time information ( text ) as shown on eBid Listing pages

(required)

# Item dispatch time information

(required)

"ReturnPolicy":

{

"Code":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(required)

"Label":

"STRING"

# Return policy text

(required)

# Return policy information

(required)

"CategoryPath":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# opted by option "FullCategoryPath=Y"

(required)

"CategoryPath2":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# Category path for second category , if category present and query opted with 'FullCategoryPath=Y'

(required)

"RepostedIDs":

"STRING",

# If listing is closed and in request option RepostedIDs=Y was set , then it return comma separated list of ids of listings reposted from this one . Most recently reposted is first in the list .

(optional)

"Variations":

{

"ImageTag":

"STRING",

# Variation image tag

(required)

[

"Variation":

{

"Image":

{

"ImageLarge":

"STRING",

# Big image URL

(required)

"ImageSmall":

"STRING",

# Small image URL

(required)

"ImageMedium":

"STRING",

# Medium image URL

(required)

"eBidImage":

VALUES SET

# Is image stored at eBid servers ? Y/N

(required)

Y=yes | N=No

# Image info

(optional)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Variation price

(required)

"Quantity":

INT,

# Items quantity

(required)

"QuantitySold":

INT,

# Quantity already Sold

(required)

"Barcode":

"STRING",

# UPC/EAN/MPN code

(required)

"ItemSpecifics":

{

"Name":

"STRING",

# Attribute name

(required)

"Value":

"STRING"

# Attribute value

(required)

# Variation specifics

(required)

]

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING",

# Variation Maximum Price (added in 2.0)

(required)

"ItemSpecifics":

[{

"Name":

"STRING",

# Tag name

(required)

"Value":

"STRING"

# Tag value

(required)

}]

(required)

}

(required)

}

GetMyEbidSold
Returns an array of listings which have resulted in sales by this user. Be it BuyNow, successful bids or accepted MaO (offers).

API Command: GetMyEbidSold
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetMyEbidSold" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"Start":

INT,

# Offset to listings table . First item in response .

(optional)

"RowsLimit":

INT,

# Number of items in response . Max 75.

(optional)

"ShortResponse":

"STRING",

# Y/( empty value ) return response in very short format.

(optional)

"Filter":

{

"Invoiced":

VALUES SET,

# Y/N/empty value . Filter to invoiced/not invoiced items only.

(optional)

Y=yes | N=No

"Paid":

VALUES SET,

# Y/N/(empty value) . Filter results payed/non payed.

(optional)

Y=yes | N=No

"Shipped":

"STRING",

# Y/N/(empty value ). Filter shipped / not shipped items.

(optional)

"Fbk_Left":

VALUES SET,

# Y/N/empty value. Filter items by feedback left .

(optional)

Y=yes | N=No

"Fbk_Rcvd":

VALUES SET,

# Y/N/empty value. Filter items by feedback received value.

(optional)

Y=yes | N=No

"Keyword":

"STRING"

# Filter items by keyword.

(optional)

}

RESPONSE

{
"APIVersion": "",

"TotalItemsCount":

INT,

# Total items in myeBid sold section

(required)

"Sold":

[{

"ListItem":

{

"ListingID":

INT,

# Listing ID

(required)

"Title":

"STRING",

# Listing title

(required)

"BidCount":

INT,

# Bids count ( include BuyNow bids )

(required)

"Currency":

"STRING",

# Listing currency code , like USD , GBP , EUR

(required)

"BuyNowAvailable":

INT,

# Quantity of items available for BuyNow option

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow pprice exchanged to current site currency

(required)

"PrimaryMarket":

"STRING",

# Listing primary market , ISO code like 'us' , 'uk'

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current price exchanged to current site currency

(required)

"Quantity":

INT,

# Listing Quantity ( all items offered by this listing )

(required)

"Views":

INT,

# Current listing page views

(required)

"ShippingCost":

"STRING",

# Lowest postage price

(required)

"ShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Category information

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Seller information

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image ( large version )

(required)

"PrimaryImageSmall":

"STRING",

# URL to primary image ( small version )

(required)

"PrimaryImageMedium":

"STRING",

# Primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N value is main image stored on eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N value is main image is part of UPC/EAN image library

(required)

"ItemsAvailableBid":

INT,

# Items count available to bid

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empty value ) is bidding available for this listing

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/(empty value) is seller accept offers for this item

(required)

Y=Yes | =No (empty value)

"AvailableTo":

VALUES SET,

# Comma separated countries like "us,uk,eu" or similar for which this listing is available

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"tick":

VALUES SET,

# Y/N value , Is this listing is success for current user ( if login info sent with query )

(optional)

Y=yes | N=No

"Winner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Current winner of listing ( if there is )

(optional)

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Listing price , is optional if user logged in

(optional)

"CurrentPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing price , is present only user logged in ( login information sent with query )

(optional)

"UnixTimeEnd":

INT,

# Listing end time , is unix timestamp or special value , 2000000000 = Run Until Sold , 2000000001 - 1 day after 1st bid , 2000000002 - 2 days after 1st bid , etc

(required)

"TimeEnd":

"STRING",

# Listing end time in printable format

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"URL":

"STRING",

# URL to listing page on eBid main site

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING"

# Variation Max Price (added in 2.0)

(required)

"UnixTime":

INT,

# UnixTimestamp when sale record added ( sale done )

(required)

"Time":

"STRING",

# Printable time when sale done

(required)

"PurchasePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item price

(required)

"PurchasePriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item price exchanged to current site currency

(required)

"Quantity":

INT,

# Quentity sold ( 0 - sale cancelled )

(required)

"ShippingPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"ShippingPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price exchanged to current site currency

(required)

"TotalAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total amount

(required)

"TotalAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total amount exchanged to current site currency

(required)

"InvoiceStatus":

VALUES SET,

# Y/N value - is invoice sent

(required)

Y=yes | N=No

"InvoiceStatusText":

"STRING",

# Printable text ( Yes/No ) is invoice sent

(required)

"PaymentStatus":

VALUES SET,

# C/R/NP/Y/YN/N values where C - Cancelled, R - Refunded, NP - Non Payed , Y - Payed, YN - Pending , N - Not Yet

(required)

"PaymentStatusText":

"STRING",

# Payment status printable text - Cancelled / Refunded / Non Payed / Payed / Pending / Not Yet

(required)

"ShipmentStatus":

VALUES SET,

# Y/N/C - is item shipped - yes , no , cancelled

(required)

Y=Shipped | N=Not Shipped | C=Cancelled

"ShipmentStatusText":

"STRING",

# text value for shipment status - Yes / No / Cancelled

(required)

"FeedbackLeftStatus":

VALUES SET,

# Is feedback left by current user - Y/N/C - Yes, No , Cancelled

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackLeftStatusText":

"STRING",

# Is feedback leaved by current user - Yes / No / Cancelled

(required)

"FeedbackReceivedStatus":

VALUES SET,

# Y/N/C - is current user received feedback for this item ( Yes / No / Cancelled )

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackReceivedStatusText":

"STRING",

# printable feedback received for this item status - Yes / No / Cancelled

(required)

"Buyer":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING",

# Printable time of last user activity

(required)

"Name":

"STRING",

# User Name

(required)

"Address1":

"STRING",

# Address line 1

(required)

"Address2":

"STRING",

# Address Line 2

(required)

"City":

"STRING",

# User city

(required)

"StateOrCounty":

"STRING",

# User state/privince/county

(required)

"Postcode":

"STRING",

# User postcode

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"UserlevelText":

VALUES SET,

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

"Userlevel":

VALUES SET

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

# Buyer info

(required)

"SaleID":

INT

# ID of sale record

(required)

}]

(required)

}

GetMyEbidWatched
Returns an array of listings which the user in session is Watching.

API Command: GetMyEbidWatched
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetMyEbidWatched" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"Start":

INT,

# Offset to listings table . First item in response .

(optional)

"RowsLimit":

INT,

# Number of items in response . Max 75.

(optional)

"ShortResponse":

"STRING"

# Y/(empty value) - if Y - then return in very short information format .

(optional)

}

RESPONSE

{
"APIVersion": "",

"TotalItemsCount":

INT,

# Total items in myWatch section

(required)

"MyWatch":

[{

"ListItem":

{

"ListingID":

INT,

# Listing ID

(required)

"Title":

"STRING",

# Listing title

(required)

"BidCount":

INT,

# Bids count ( include BuyNow bids )

(required)

"Currency":

"STRING",

# Listing currency code , like USD , GBP , EUR

(required)

"BuyNowAvailable":

INT,

# Quantity of items available for BuyNow option

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow pprice exchanged to current site currency

(required)

"PrimaryMarket":

"STRING",

# Listing primary market , ISO code like 'us' , 'uk'

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current price exchanged to current site currency

(required)

"Quantity":

INT,

# Listing Quantity ( all items offered by this listing )

(required)

"Views":

INT,

# Current listing page views

(required)

"ShippingCost":

"STRING",

# Lowest postage price

(required)

"ShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Category information

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Seller information

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image ( large version )

(required)

"PrimaryImageSmall":

"STRING",

# URL to primary image ( small version )

(required)

"PrimaryImageMedium":

"STRING",

# Primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N value is main image stored on eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N value is main image is part of UPC/EAN image library

(required)

"ItemsAvailableBid":

INT,

# Items count available to bid

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empty value ) is bidding available for this listing

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/(empty value) is seller accept offers for this item

(required)

Y=Yes | =No (empty value)

"AvailableTo":

VALUES SET,

# Comma separated countries like "us,uk,eu" or similar for which this listing is available

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"tick":

VALUES SET,

# Y/N value , Is this listing is success for current user ( if login info sent with query )

(optional)

Y=yes | N=No

"Winner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Current winner of listing ( if there is )

(optional)

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Listing price , is optional if user logged in

(optional)

"CurrentPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing price , is present only user logged in ( login information sent with query )

(optional)

"UnixTimeEnd":

INT,

# Listing end time , is unix timestamp or special value , 2000000000 = Run Until Sold , 2000000001 - 1 day after 1st bid , 2000000002 - 2 days after 1st bid , etc

(required)

"TimeEnd":

"STRING",

# Listing end time in printable format

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"URL":

"STRING",

# URL to listing page on eBid main site

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING"

# Variation Max Price (added in 2.0)

(required)

"CloseSoon":

VALUES SET

# Y/N value - is listing closed soon

(required)

Y=yes | N=No

}]

(required)

}

GetUserDefaults
Returns the data as seen in the My Defaults > My Selling Defaults section of My eBid on our main website. These are saved listing details, eg. title and price that are used to populate the listing form when putting an item up for sale.

API Command: GetUserDefaults
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetUserDefaults" ,

"LoginKey":

"STRING"

# User login key

(required)

}

RESPONSE

{
"APIVersion": "",

"UserDefaultsMain":

{

"EditorType":

VALUES SET,

# N/S/Y - WYSIWYG/SIMPLE/no editor

(required)

N=no editor | S=SIMPLE | Y=WYSIWYG

"InvoiceDefaultText":

"STRING",

# Default text used in invoices

(required)

"ResetCounter":

VALUES SET,

# Y/N - reset view counter when listing auto repost

(required)

Y=yes | N=No

"GoogleExport":

VALUES SET,

# Y/N - is exported to google shopping

(required)

Y=yes | N=No

"HideReserve":

VALUES SET,

# Y/N - hide reserves for closed listings , normally reserve shown .

(required)

Y=yes | N=No

"ZipFromChoose":

"STRING",

# choose place from where items ship - (empty) - from account zip , B - from bussines address zip , C - other place , then zip set in ZipFromDefault

(required)

"ZipFromDefault":

"STRING",

# zip code - place from where items ship if calculate from other zip choose as option

(required)

"DeleteBeforeFtpLanch":

VALUES SET

# Y/N - delete all listings when upload listings to ftp

(required)

Y=yes | N=No

(required)

[

"ListingDefaults":

{

"Defaults":

{

"ProfileName":

"STRING",

# This listing profile name

(required)

"Title":

"STRING",

# Listing title

(required)

"SubTitle":

"STRING",

# Listing subtitle ( if present , payable option)

(required)

"Category2":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

# Second category ( if present , payable option )

(required)

"Bold":

VALUES SET,

# Y/N value , is listing featured to bold

(required)

Y=yes | N=No

"Highlight":

VALUES SET,

# Y/N value , is listing featured to highlight

(required)

Y=yes | N=No

"Movie":

"STRING",

# Movie code , see movie field on eBid site

(required)

"Quantity":

INT,

# Listing Quantity

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image ( large version )

(required)

"PrimaryImageSmall":

"STRING",

# URL to primary image ( small version )

(required)

"PrimaryImageMedium":

"STRING",

# URL to primary image ( medium version )

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N value , is primary image uploaded to eBid

(required)

"StartPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing start price

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price

(required)

"FixedPrice":

VALUES SET,

# Y/N value , is this fixed price listing

(required)

Y=yes | N=No

"Description":

"STRING",

# Listing Description

(required)

"Store":

{

"StoreID":

INT,

# Store ID

(required)

"Owner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Store owner

(required)

"Title":

"STRING",

# Store title ( name )

(required)

"Description":

"STRING",

# Store description

(required)

"Category":

INT,

# Store classification category ID ( ebid categories )

(required)

"Image":

"STRING",

# URL of store banner image

(required)

"ListingsCount":

INT,

# Count of listings in this store

(required)

"Link":

"STRING",

# URL to store ( link to eBid )

(required)

"Online":

VALUES SET

# Y/N value is store online

(required)

Y=yes | N=No

# Listing store , if present for this listing

(required)

"StoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Listing store category , if present for this defaults

(required)

"SKU":

"STRING",

# Listing SKU

(required)

"ItemCondition":

{

"ID":

VALUES SET,

# Item condition id , n - new , u - used , s - unused , r - refurbished , '' - any

(required)

n=New | u=Used | s=Unused | r=Refurbished | =Any

"Name":

"STRING",

# Printable name of option

(required)

"APIName":

"STRING"

# API name to refer for API ( NEW , USED, UNUSED, REFURBISHED, ANY )

(required)

# Item condition

(required)

"PaymentOptions":

{

"PaymentOption":

[{

"ID":

INT,

# Option ID

(required)

"Name":

"STRING"

# Option name

(required)

}]

(required)

# Available payment options

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"Duration":

{

"Days":

INT,

# Days

(required)

"Hours":

INT,

# Hours

(required)

"Mins":

INT,

# Mins

(required)

"AutoExtend":

VALUES SET,

# Y/N value - is listing autoextended when busy bids made near listing end

(required)

Y=yes | N=No

"UntilSold":

VALUES SET

# Y/N valus is listing Run Until Sold ( then time is ignored )

(required)

Y=yes | N=No

# Listing duration

(required)

"Tax":

{

"RawString":

"STRING"

# tax information in raw eBid format

(required)

# Tax information

(required)

"ReservePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing reserve price

(required)

"NoReserve":

VALUES SET,

# Y/N value if there is no reserve price

(required)

Y=yes | N=No

"RepostCount":

INT,

# default autorepost count value

(required)

"HideAdult":

VALUES SET,

# Y/N value , hide adult usernames

(required)

Y=yes | N=No

"StartListing":

{

"Type":

"STRING",

# Start listing type - text 'Custom' , 'Immediately' , 'OnFirstBid'

(required)

"Unixtime":

INT

# If start time is custom then unixtimestamp of custom start time

(required)

# Start listing time/type

(required)

"Date":

"STRING",

# If start time is custom then printable time of custom start time

(required)

"DomesticShippings":

{

"RawString":

"STRING"

# Domestic shipping string in raw eBid format

(required)

# Domestic shippinng

(required)

"InternationalShippings":

{

"RawString":

"STRING"

# International shipping in raw internal eBid format

(required)

# International shipping

(required)

"IsProfileDefault":

VALUES SET,

# Y/N value is this profile is default for this user

(required)

Y=yes | N=No

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# (added in 2.0)

(optional)

"Variations": # (added in 2.0)

{

[

"Variation":

{

[

"Image":

{

"ImageLarge":

"STRING",

# Large Image URL

(required)

"ImageSmall":

"STRING",

# Small Image URL

(required)

"ImageMedium":

"STRING",

# Medium Image URL

(required)

"eBidImage":

VALUES SET

# Is image stored at eBid server

(required)

Y=yes | N=No

(optional)

]

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Variation price

(required)

"Quantity":

INT,

# Variation quantity

(required)

"Barcode":

"STRING",

# UPC/EAN/ISBN/MPN code

(required)

"ItemSpecifics":

{

"Name":

"STRING",

# Tag name

(required)

"Value":

"STRING"

# Specifics value

(required)

# Variation Specifics

(required)

}

(optional)

]

# (added in 2.0)

(optional)

}

(required)

}

(optional)

]

}

SaveQuestionNew
Allows a user to ask a question relating to a live listing, or reply to a question already asked.

API Command: SaveQuestionNew
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "SaveQuestionNew" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"ListingID":

"STRING",

# Listing ID

(required)

"Message":

"STRING",

# Question message

(required)

"InReply":

INT

# ID of question replied if posted reply to question . If you post not reply but question leave this field empty.

(optional)

}

RESPONSE

{
"APIVersion": "",

"Question":

{

"QuestionID":

INT,

# Question ID

(required)

"ListingID":

INT,

# Listing ID

(required)

"Poster":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Question poster ( user object )

(required)

"UnixTime":

INT,

# Unixtimestamp time when question/reply posted

(required)

"Time":

"STRING",

# Printable question/reply time

(required)

"Message":

"STRING",

# Question/Reply text

(required)

"ReplyToID":

INT,

# ID of question replied or empty if is not reply

(required)

"NudgeCount":

INT,

# Nudge count ( how many times user nudged question )

(required)

"LastNudgeUnixTime":

INT,

# Unix timestamp when question last nudged

(required)

"LastNudgeTime":

"STRING"

# Printable time when question last time nudged

(required)

}

(required)

}

SaveUnwatchListing
Send request to stop watching a listing ID that is currently in a user's Watching section of My eBid.

SaveWatchListing
This method will save a listing ID to the Watching section of a users "My eBid" area.

SEARCH & BROWSE Methods
eBid API methods relating to the searching of and categorization of listings within the eBid ecosystem.

GetCategoryInfo
This function return single category information. If category ID is wrong then it will return error.

GetCategoryList
This function return all categories below root category or any subcategory . If CategoryID set to 0 then all root categories will return , if category is not zero then all subcategories of this category will return . 'NoAdult' option force return non-adult categories only.

GetCategoryListDeep
This function return all categories below spacified. Difference to GetCategoryList is return all subcategories with all levels below , and specify category id to zero will return all eBid categories . Please cache this function results at user side . eBid categories changed is not often.

GetCategoryPath
This function return one or few categories that allow to output category navigation like category -> subcategory1 -> subcategory2 -> subcategory3 ... CategoryID is lowest category ID in this path.

GetCategorySpecifics
Get Category Item Specifics Data

SearchEbid
Search live eBid listings by keywords and various other filter.

API Command: SearchEbid
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "SearchEbid" ,

"CategoryID":

INT,

# Searched listings within this categoryid

(optional)

"StoreID":

INT,

# Store ID , search listings within this store id

(optional)

"StoreCategoryID":

INT,

# Search listings within this store category

(optional)

"InDescription":

VALUES SET,

# Y/N value . By default text searched in title , setting this option to Y descriptions will be searched as well

(optional)

Y=yes | N=No

"MinPrice":

"STRING",

# Minumal Price for item ( in current site currency )

(optional)

"MaxPrice":

"STRING",

# Maximum price to search ( in current site currency )

(optional)

"MinFeedback":

INT,

# Search listings which posted by sellers with this minimal feedback .

(optional)

"Keyword":

"STRING",

# Search keyword , same rules as eBid main site

(optional)

"Adult":

VALUES SET,

# Y/N value - is adult listings allowed in search results

(optional)

Y=yes | N=No

"ItemCondition":

VALUES SET,

# Item conditional , 'NEW', 'USED', 'UNUSED', 'REFURBISHED', 'ANY'

(optional)

NEW=New | USED=Used | UNUSED=Unused | REFURBISHED=Refurbished | ANY=Any

"UserID":

INT,

# Is user id . To search only this user listings

(optional)

"Username":

"STRING",

# Is username of user . To search only this user listings.

(optional)

"Country":

VALUES SET,

# Country ISO code like 'uk', 'us' , search will return only items by this country origin.

(optional)

"BuyItNow":

VALUES SET,

# Y/N value . If set to Y then search will return only listings with buynow option .

(optional)

Y=yes | N=No

"InClosed":

VALUES SET,

# Y/N value . By default function search live listings . If this option is setto Y then it search closed listings (only)

(optional)

Y=yes | N=No

"ItemLocationMiles":

INT,

# Search items by miles range from some postcode . This is number of miles. Reuqire to set as well ItemLocationPostcode .

(optional)

"ItemLocationPostcode":

"STRING",

# Postcode for search items within ItemLocationMiles range.

(optional)

"StartedAfter":

INT,

# Unix timestamp , search will retun all listings that sterted or will start after this timestamp time.

(optional)

"CategoryPath":

VALUES SET,

# Y/N value. Is categories that included in current category path need send in reponse . If set all categories like Category -> Subcategory -> Subcategory1 ... will be included in the tag 'CategoryPath'

(optional)

Y=yes | N=No

"CategorySuggestion":

VALUES SET,

# Y/N value , is categiry suggestion information required in response . If set to Y , then CategorySuggestion optional tag will be in response , and will include all categoris below searched , with items count found in thse categroies. Depend from is set Ca

(optional)

Y=yes | N=No

"CategorySuggestionShort":

VALUES SET,

# Y/N value - is category counters ( category suggestion ) need return is short format . Short format include categoryid+count , but normal format include full category data as well .

(optional)

Y=yes | N=No

"CategorySuggestionOnly":

VALUES SET,

# Y/N value . If this option is set , then search result will return category suggestion data only , and no searched listings . Is helpful when you need do navigation via categories in search results and no listings show .

(optional)

Y=yes | N=No

"CategorySuggestionNoExpand":

VALUES SET,

# Y/N value . By default API return all subcategories data with counts . No matter how deep is from searched category . This option force return results only for searched subcategories level . It decrease traffic when you not need it.

(optional)

Y=yes | N=No

"Sort":

VALUES SET,

# Sort options , available values : TIME_REMAINING_ASC, TIME_REMAINING_DESC, TITLE_ASC, TITLE_DESC, PRICE_ASC, PRICE_DESC, START_TIME_ASC, CONDITION_ASC, CONDITION_DESC, NEAREST_TO_ME . for closed listing as well : CLOSED_MOST_DISTANT , CLOSED_MOST_RECENT,

(optional)

"Start":

INT,

# Start position in search results , 20 mean from 20th listings in search results . Is for page navigation . Default = 0 , from begin.

(optional)

"RowsLimit":

INT,

# How many rows return in search result . Is applicable only for listings results , and must not exceed 75 listings per query.

(optional)

"StoreCategorySuggestion":

VALUES SET

# Y/N value , if StoreID is set also then return array of store categories with counts

(optional)

Y=yes | N=No

}

RESPONSE

{
"APIVersion": "",

"TotalItemsCount":

INT,

# Total items found

(required)

"ListItem":

[{

"ListingID":

INT,

# Listing ID

(required)

"Title":

"STRING",

# Listing title

(required)

"BidCount":

INT,

# Bids count ( include BuyNow bids )

(required)

"Currency":

"STRING",

# Listing currency code , like USD , GBP , EUR

(required)

"BuyNowAvailable":

INT,

# Quantity of items available for BuyNow option

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow pprice exchanged to current site currency

(required)

"PrimaryMarket":

"STRING",

# Listing primary market , ISO code like 'us' , 'uk'

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current price exchanged to current site currency

(required)

"Quantity":

INT,

# Listing Quantity ( all items offered by this listing )

(required)

"Views":

INT,

# Current listing page views

(required)

"ShippingCost":

"STRING",

# Lowest postage price

(required)

"ShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Category information

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Seller information

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image ( large version )

(required)

"PrimaryImageSmall":

"STRING",

# URL to primary image ( small version )

(required)

"PrimaryImageMedium":

"STRING",

# Primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N value is main image stored on eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N value is main image is part of UPC/EAN image library

(required)

"ItemsAvailableBid":

INT,

# Items count available to bid

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empty value ) is bidding available for this listing

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/(empty value) is seller accept offers for this item

(required)

Y=Yes | =No (empty value)

"AvailableTo":

VALUES SET,

# Comma separated countries like "us,uk,eu" or similar for which this listing is available

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"tick":

VALUES SET,

# Y/N value , Is this listing is success for current user ( if login info sent with query )

(optional)

Y=yes | N=No

"Winner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Current winner of listing ( if there is )

(optional)

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Listing price , is optional if user logged in

(optional)

"CurrentPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing price , is present only user logged in ( login information sent with query )

(optional)

"UnixTimeEnd":

INT,

# Listing end time , is unix timestamp or special value , 2000000000 = Run Until Sold , 2000000001 - 1 day after 1st bid , 2000000002 - 2 days after 1st bid , etc

(required)

"TimeEnd":

"STRING",

# Listing end time in printable format

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"URL":

"STRING",

# URL to listing page on eBid main site

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING"

# Variation Max Price (added in 2.0)

(required)

}],

(required)

"CategoryPath":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# Category path ( categories list enough to generate categopry path ) included only with param 'CategoryPath=Y' and categoryid > 0

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# User object included only if searched user listings

(optional)

"CategorySuggestion":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Category suggestion , categories with counters that is on same level as searched categories. Depend from parameter can be with full category info , or just categoryid + count.

(required)

"StoreCategories":

{

[

"StoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

}

(required)

]

}

# Store categories if parameter StoreCategorySuggestion is set and StoreID is set as well

(optional)

}

SELLING Methods
eBid API methods that are related to the listing of items for sale on eBid, be it via Auction, BuyNow or Make an Offer (MaO).

GetCountryStates
Returns state/counties/provinces for an eBid country site.

GetEbidSites
Returns all active eBid sites around the world.

API Command: GetEbidSites
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetEbidSites" ,

}

RESPONSE

{
"APIVersion": "",

"Site":

[{

"Code":

VALUES SET,

# ISO country/continent code like 'us' or 'eu'

(required)

"Country":

"STRING",

# Country name like 'United States'

(required)

"Language":

"STRING",

# Site language

(required)

"Currency":

{

"CurrencyCode":

"STRING",

# ISO currency code like 'USD' , 'EUR'

(required)

"CurrencySign":

"STRING",

# Currency sign for screen output

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for emails ( text , not html )

(required)

"CurrencyName":

"STRING"

# Currency name like 'Euros', 'British Pounds'

(required)

# Currency information

(required)

"Continent":

"STRING",

# Continent ISO code if this site is continen site like eu.ebid.net . eBid operate as on single countries as on continents as well.

(required)

"LocatedOnContinent":

VALUES SET,

# Continent ISO code where site country located , like 'eu' for all european sites

(required)

"DomesticPostageCalc":

VALUES SET,

# Y/(empty values) , is this site have option to use some third postage providers calculations for domestic postages .

(required)

Y=Yes | =No (empty value)

"InternationalPostageCalc":

VALUES SET,

# Y/(empty values) , is this site have option to use some third postage providers calculations for international postages .

(required)

Y=Yes | =No (empty value)

"WeightUnit":

{

"Code":

VALUES SET,

# Weight code 'lb' or 'kg'

(required)

lb=lb | kg=kg

"High":

"STRING",

# High weight unit label , 'lbs.' or 'kgs.'

(required)

"Low":

"STRING"

# Low weight unit 'oz.' or 'gr.'

(required)

# Weight unit

(required)

"MeasureUnit":

{

"Code":

VALUES SET,

# Measure unit code 'in' or 'cm'

(required)

in=inch | cm=cm

"Name":

"STRING"

# Measure unit label. 'in'. or 'cm'

(required)

# Site measure unit

(required)

"DistanceSearch":

VALUES SET,

# Y/(empty value) - is distance search available on this site . distance search is search for xx km apart of some postcode.

(required)

Y=Yes | =No (empty value)

[

"ExtraCurrency":

{

"CurrencyCode":

"STRING",

# ISO currency code like 'USD' , 'EUR'

(required)

"CurrencySign":

"STRING",

# Currency sign for screen output

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for emails ( text , not html )

(required)

"CurrencyName":

"STRING"

# Currency name like 'Euros', 'British Pounds'

(required)

# Extra curriencies available for the country

(optional)

]

}],

(required)

"LangState":

"STRING",

# Text label for county/state

(required)

"LangPostcode":

"STRING"

# Text label for country postcode

(required)

}

GetItemConditionValues
Returns the possible values for the "Item Condition" field on the listing form. Can be used to create SELECT lists, add to keyword search forms etc.

GetListingDetailsFull
This function requires a user to be logged in and returns full data on a listing, can be used to populate edit forms. It will return more information than is available to the public. eg. Reserve prices and and full shipping data for all countries.

API Command: GetListingDetailsFull
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetListingDetailsFull" ,

"LoginKey":

"STRING",

# User Login Key

(required)

"ListingID":

INT,

# Listing ID

(required)

"ShipTo":

VALUES SET,

# ISO country to calculate shipping to . Like 'uk', 'us' etc

(optional)

"ShipToZip":

"STRING",

# Zip/Postcode to calculate shipping to . If it need for calculations.

(optional)

"WithBids":

VALUES SET,

# Y/(empty value) - if set then tag Bids filled with bids history

(optional)

Y=Yes | =No (empty value)

"WithASL":

VALUES SET,

# Y/N value. If set to Y , then ASL log will be included in result .

(optional)

Y=Yes | =No (empty value)

"WithAdultHiddenNames":

VALUES SET,

# Y/N value . if set to Y , then array of hidden names UserID -> name to show will return .

(optional)

Y=Yes | =No (empty value)

"QuestionsHistory":

VALUES SET,

# Y/N value. if set then question history will return in results .

(optional)

Y=Yes | =No (empty value)

"QuestionsCount":

VALUES SET,

# Y/N value . If set to Y then in result will include questions count in tag 'QuestionsCount'

(optional)

Y=Yes | =No (empty value)

"FullCategoryPath":

VALUES SET,

# Y/N value . If set to Y then all categories info need to create categories path will be included in result . Tag 'CategoryPath'.

(optional)

Y=Yes | =No (empty value)

"GetUserListingsCount":

VALUES SET,

# Y/N value . If set to Y , Then seller listings count will return in result.

(optional)

Y=Yes | =No (empty value)

"WithVariations":

VALUES SET

# Include variations data in response (added in 2.0)

(optional)

Y=yes | N=No

}

RESPONSE

{
"APIVersion": "",

"ListingID":

INT,

# Listing ID

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Listing Seller data

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Listing category

(required)

"Category2":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Second category , if present or empty tag is not

(optional)

"Title":

"STRING",

# Listing title

(required)

"SubTitle":

"STRING",

# Listing subtitle ( if present )

(required)

"Bold":

VALUES SET,

# Y/N value , is listing bold

(required)

Y=yes | N=No

"Highlight":

VALUES SET,

# Y/N value , is listing highlighten in listings

(required)

Y=yes | N=No

"Movie":

"STRING",

# Listing movie ID

(required)

"Brand":

"STRING",

# Listing brand

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image large version ( or empty )

(required)

"PrimaryImageSmall":

"STRING",

# URL to Listing primary image small version or empty

(required)

"PrimaryImageMedium":

"STRING",

# URL to Listing primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N - Is image uploaded to eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N , is image is part of UPC/EAN library

(required)

"Quantity":

INT,

# Listing quantity ( 1 - max value )

(required)

"StartTime":

"STRING",

# Listing start time printable version

(required)

"StartTimeUnix":

INT,

# Start time , Unixtimestamp

(required)

"StartPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing Start price value

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"NextBid":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Next prossible bid or empty if not applicable

(required)

"Increment":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Increment value

(required)

"BidCount":

INT,

# Count of bids already made

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"BuyNowAvailable":

INT,

# Items quantity available for BuyNow

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price for this Listing

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price exchanged to local currency ( current country view )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price exchanged to current country currency

(required)

"Views":

INT,

# Listing views count ( how many it was viewed on eBid )

(required)

"Description":

"STRING",

# Listing Description

(required)

"Store":

{

"StoreID":

INT,

# Store ID

(required)

"Owner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Store owner

(required)

"Title":

"STRING",

# Store title ( name )

(required)

"Description":

"STRING",

# Store description

(required)

"Category":

INT,

# Store classification category ID ( ebid categories )

(required)

"Image":

"STRING",

# URL of store banner image

(required)

"ListingsCount":

INT,

# Count of listings in this store

(required)

"Link":

"STRING",

# URL to store ( link to eBid )

(required)

"Online":

VALUES SET

# Y/N value is store online

(required)

Y=yes | N=No

# Listing Store

(required)

"StoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Store category where listing listed ( or empty if not in store )

(required)

"ParentStoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Parent Store category where it listed or empty value

(required)

"AutoExtended":

VALUES SET,

# Y/N value , is autoextend set for Listing

(required)

Y=yes | N=No

"Barcode":

"STRING",

# UPC/EAN barcode code or empty value , or special value "EXEMPT"

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"ItemCondition":

{

"ID":

VALUES SET,

# Item condition id , n - new , u - used , s - unused , r - refurbished , '' - any

(required)

n=New | u=Used | s=Unused | r=Refurbished | =Any

"Name":

"STRING",

# Printable name of option

(required)

"APIName":

"STRING"

# API name to refer for API ( NEW , USED, UNUSED, REFURBISHED, ANY )

(required)

# Listing item condition

(required)

"PaymentOptions":

{

"PaymentOption":

[{

"ID":

INT,

# Option ID

(required)

"Name":

"STRING"

# Option name

(required)

}]

(required)

# Payment options available for listing

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"ShipTo":

VALUES SET,

# ISO country code for which current shipping price calculated

(required)

"ShipToName":

"STRING",

# Country name to which current shipping prices calculated

(required)

"ShipToZip":

"STRING",

# zip/postcode to which current shipping price calculated ( if required or present ).

(required)

"Shippings":

{

"DomesticShippings":

{

"Type":

"STRING",

# constant - "calculated"

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions (cm , or inch)

(required)

"Weight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Package weight ( for some countries is kg and gramms )

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

"STRING",

# Package girth ( inch )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Fedex package options or empty values

(optional)

}],

(required)

"PackageName":

"STRING"

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"DomesticShippings":

{

"Type":

"STRING",

# "flat" - is hardcoded , can be used to indefiny shipping type

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL

# Extra item shipping price ( if different then 1st item shipping price and if multi item listing )

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# shipping object type , hardcoded value "calculated"

(required)

"Handling":

DECIMAL,

# handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions ( in cm or inch depend from country )

(required)

"Weight":

{

"Lbs":

"STRING",

(required)

"Oz":

"STRING"

(required)

# Package weigh lb & oz or kg and gramms depend from country

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"PackageName":

"STRING",

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

DECIMAL,

# Package girth ( if applicable )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Options filled only if package is fedex

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# postage type , hardcoded value "flat"

(required)

"Option":

[{

"ShippingService":

"STRING",

# Postage service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL,

# Extra item shipping price ( if quantity more then 1 and shipping price is different then 1st item )

(required)

"AvailableTo":

VALUES SET

# Comma separated ISO country lists to which this shipping possible ( like "uk,us,de" )

(required)

}]

(required)

"Shipping":

{

"Code":

"STRING",

# Shipping method eBid code

(required)

"Name":

"STRING",

# Shipping method postage name ( like Royal Mail 1st Class , Parcelforce (2 Day Delivery) , etc )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"PriceExchanged":

"STRING",

# Shipping price exchanged to current site currency

(required)

"Calculated":

"STRING",

# Y/N - is price received from postage service provider ( N - defined directly by user )

(required)

"ShippingTo":

"STRING",

# ISO Country code for this shipping price ( like uk , us, etc )

(required)

"ShippingToName":

"STRING",

# Country Name for this shipping price ( like United States , Canada , etc )

(required)

"ExtraDetails":

"STRING"

# Extar details for this postage method ( Not available or to be calculated ) , can replace price by this text

(required)

}

(required)

# Listing shipping data . Depend from parameters and listing shipping data this tag may include different optional shipping parameters.

(required)

"MinShippingCost":

"STRING",

# Minimal shipping cost for this listing to choosed or default country

(required)

"MinShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"MinShippingCostName":

"STRING",

# Minimal shipping cost postage method ( printable label like "Royal Mail Airmail" ...)

(required)

"UserListingsCount":

INT,

# Listings count for this listing , is optional depend from parameters.

(optional)

"ShipZipRequiredDom":

VALUES SET,

# Y/(empty value) , is zip postacode required to calculate Domestic shipping prices

(required)

Y=Yes | =No (empty value)

"ShipZipRequiredInt":

VALUES SET,

# Y/(empty value) is zip/postcode required to calculate international price

(required)

Y=Yes | =No (empty value)

"Bids":

{

"Bid":

[{

"BidID":

INT,

# Bid ID

(required)

"BuyNow":

VALUES SET,

# Y/(empty value) - is this buynow bid record

(required)

Y=Yes | =No (empty value)

"UserID":

INT,

# Bidder UserID ( possible 0 - when name hidden , adult listings)

(required)

"Username":

"STRING",

# Bidder username

(required)

"UnixTime":

"STRING",

# Unix Timestamp when bid made

(required)

"Amount":

"STRING",

# Bid amount , possible value "Not Public" for non public values

(required)

"Allocation":

INT,

# Quandtity allocated by this bid ( for dutch listings possible less then quantity )

(required)

"Quantity":

INT,

# Bid quantity

(required)

"QuantityText":

"STRING",

# Printable bid quantity , use to output

(required)

"Time":

"STRING",

# Printable bid time

(required)

"MAO":

VALUES SET,

# Y/(empty value) - is bid generated by successful offer

(required)

Y=Yes | =No (empty value)

"IconType":

VALUES SET,

# Bid icon type - p, r, b ( proxy , reserve meet , buynow )

(required)

p=Proxy | r=Reserve meet | b=Buynow

"IconImages":

"STRING",

# Icon images tags , include IMG tage , possible few together.

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Bidder user object , may not be here if private listing , or can be full version if some params present.

(optional)

"HiddenName":

VALUES SET,

# Y/(empty value) - is name hidden

(required)

Y=Yes | =No (empty value)

"NotPublic":

VALUES SET,

# Y/(empty value) - is amount public or no

(required)

Y=Yes | =No (empty value)

"BuyerFullInfo":

VALUES SET

# Y/(empty value) - is User tag include full version of user object

(required)

Y=Yes | =No (empty value)

}]

(required)

# Bids history for this listing , only if it required in initial query , or empty value

(required)

"Type":

VALUES SET,

# "n" or "d" char , Listing type n-single item listing , d - multi item listing

(required)

n=Single item listing | d=Multi item listing

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing/listing price

(required)

"AdultHiddenName":

[{

"UserID":

INT,

# UserID

(required)

"Username":

"STRING"

# Hidden name replacement like "hiddenname1"

(required)

}],

(required)

"AdultHide":

"STRING",

# Y/N value - is listing opted as Adult Hide Usernames

(required)

"ItemsAvailableBid":

INT,

# Quantity available to bid . If holiday notice set - bidding is not available .

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empy value) - is bidding available for this listing now . Do not show bid form if this field is not set to Y.

(required)

Y=Yes | =No (empty value)

"HolidayNotice":

VALUES SET,

# Y/N value . Is User notice is holiday ( user is on vacancy , and bidding not available )

(required)

Y=yes | N=No

"HolidayNoticeText":

"STRING",

# Holiday notice text , If notify is present then user text or empty.

(required)

"Watch":

VALUES SET,

# Y/N value , is current user watching this listing , only if login info sent with request .

(required)

Y=yes | N=No

"ListingStateSuccess":

VALUES SET,

# Y/N value , is this listing for current user is success ( high bidder , buyed via buynow ) , empty value if user login info not sent with query

(required)

Y=yes | N=No

"ListingStateMessage":

"STRING",

# Listing status message normally shown on eBid listing page at top , only for logged in users ( if login info sent with query )

(required)

"ListingQuestionState":

"STRING",

# Listing question state , only if login data sent with this query e.q. for logged info only . Or empty.

(required)

"Live":

VALUES SET,

# Y/(empty value) - is listing live , e.q. running . listing is live while it not moved to myeBid closed area ( not just time expired ).

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/N value - Is seller accept offers for this listing .

(required)

Y=yes | N=No

"OffersStatus":

"STRING",

# Offers status normally shown at top of eBid listing page , is not empty if seller accept offers , some offer made , and user logged in ( logged info sent with query )

(required)

"OffersAttentionRequired":

VALUES SET,

# Y/N value , is current offers required logged user attention . For example seller attention required when offers made . Is set only if logged user info provided with query.

(required)

Y=yes | N=No

"OffersHistoryCount":

INT,

# How many offers made for this listing/listing

(required)

"PrimaryMarket":

VALUES SET,

# Primary market ISO country code like "us" , "uk" , "eu" ...

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list like "us,uk,eu" or similar . Listing is available on these eBid markets .

(required)

"ASL":

[{

"Sale":

{

"SaleID":

INT,

# Sale ID

(required)

"Buyer":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Buyer info

(required)

"UnixTime":

INT,

# Unix Timestamp when sale made

(required)

"Time":

"STRING",

# Printable when sale made

(required)

"PurchasePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price

(required)

"PurchasePriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price exchanged to current country currency

(required)

"Quantity":

INT,

# Quantity of items purchased

(required)

"ShippingPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"ShippingPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price exchanged to current country currency

(required)

"TotalAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Total sale amount

(required)

"TotalAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total Amount exchanged to current country currency

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

}

# Items Seller object

(required)

"Status":

{

"InvoiceStatus":

VALUES SET,

# Y/N value is invoice sent

(required)

Y=yes | N=No

"InvoiceStatusText":

"STRING",

# is invoice sent - Yes/No text status

(required)

"PaymentStatus":

VALUES SET,

# C/R/NP/Y/YN/N values where C - Cancelled, R - Refunded, NP - Non Payed , Y - Payed, YN - Pending , N - Not Yet

(required)

"PaymentStatusText":

"STRING",

# Payment status printable text - Cancelled / Refunded / Non Payed / Payed / Pending / Not Yet

(required)

"ShipmentStatus":

VALUES SET,

# Y/N/C - is item shipped - yes , no , cancelled

(required)

Y=Shipped | N=Not Shipped | C=Cancelled

"ShipmentStatusText":

"STRING",

# text value for shipment status - Yes / No / Cancelled

(required)

"FeedbackLeftStatus":

VALUES SET,

# Is feedback left by current user - Y/N/C - Yes, No , Cancelled

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackLeftStatusText":

"STRING",

# Is feedback leaved by current user - Yes / No / Cancelled

(required)

"FeedbackReceivedStatus":

VALUES SET,

# Y/N/C - is current user received feedback for this item ( Yes / No / Cancelled )

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackReceivedStatusText":

"STRING"

# printable feedback received for this item status - Yes / No / Cancelled

(required)

"AvailableOptions":

{

"Option":

[{

"ID":

INT,

# ASL option ID

(required)

"Code":

VALUES SET,

# ASL string code like (PayNowViaPPPay, RequestInvoiceFromSeller ...) , use this to make all checks in code.

(required)

"Text":

"STRING",

# Option title ( use to show on screen as choose option )

(required)

"ExtraParam":

"STRING",

# Some extra params for option , currently used only for question reply and include question ID .

(required)

"TextNeed":

VALUES SET

(required)

Y=user required enter text | N=text is not need | C=option cannot be submit

}]

(required)

# Available after sale actions

(required)

"Log":

{

"Message":

[{

"ID":

INT,

# ASL log entry ID

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# ASL log user ( who logged )

(required)

"UnixTime":

INT,

# Unix timestamp when entry added

(required)

"Time":

"STRING",

# Printable time when log entry added

(required)

"Type":

VALUES SET,

# A numeric value relating to the type of ASL entry.

(required)

"TextType":

"STRING",

# Log entry type ( printable text )

(required)

"Details":

"STRING",

# Log entry message ( entered by user or generated )

(required)

"ReplyTo":

INT,

# ReplyID to some other log entry ( only for questions replies )

(required)

"NudgeCount":

INT,

# Nudge count ( questions only )

(required)

"LastNudgeUnixTime":

INT,

# Unix Timestamp of last nudge ( questions only )

(required)

"LastNudge":

"STRING",

# Last nudge time ( printable format )

(required)

"FeedbackMessage":

"STRING"

# Feedback message ( only for feedbacks )

(required)

}]

(required)

# ASL Log entry

(required)

}],

(required)

"ReservePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing reserve price .

(required)

"AutoOfferAcceptPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers auto accept price

(required)

"AutoOfferDeclinePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers Auto decline price

(required)

"ToRepostCount":

INT,

# Count of autoreposts still due for this listing

(required)

"ToRepostOriginalCount":

INT,

# Initial value of count of listing autoreposts

(required)

"BuynowDiscount":

DECIMAL,

# Current buynow discount rate , is percent from 0 to 99.9

(required)

"ItemSpecificRaw":

"STRING",

# Item specific string , color , sizes , etc . Same format as for bulk upload .

(required)

"Duration":

{

"Days":

INT,

# Days

(required)

"Hours":

INT,

# Hours , available to Seller+ accounts only

(required)

"Mins":

INT,

# Mins , available for Seller+ accounts only

(required)

"UntilSold":

VALUES SET,

# Y/(empty value ) is this listing is Run Until Sold , if so then Days/Hours/Mins is empty

(required)

Y=Yes | =No (empty value)

"AutoExtend":

VALUES SET

# Y/N value , is listing auto extended when busy bids made.

(required)

Y=yes | N=No

# Original listing duration

(required)

"StartListing":

{

"Type":

VALUES SET

# Listing start options : "immediately" , "onfirstbid"

(required)

immediate=Immediate | onfirstbid=On firts bid | custom=Custom time

# Listing start information

(required)

"Tax":

[{

"State":

"STRING",

# Tax state code ( like NY, FL etc )

(required)

"Rate":

DECIMAL,

# Tax rate ( percent )

(required)

"ApplyToShipping":

VALUES SET

# Y/(empty value) - is tax applied to shipping also

(required)

Y=Yes | =No (empty value)

}],

(required)

"URL":

"STRING",

# Listing URL pointed to eBid listing page

(required)

"QuestionsCount":

INT,

# Questions count or empty value. Questions count provided only with options "QuestionsCount=Y" or "QuestionsHistory=Y"

(required)

"Questions":

{

"QuestionID":

INT,

# Question ID

(required)

"ListingID":

INT,

# Listing ID

(required)

"Poster":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Question poster ( user object )

(required)

"UnixTime":

INT,

# Unixtimestamp time when question/reply posted

(required)

"Time":

"STRING",

# Printable question/reply time

(required)

"Message":

"STRING",

# Question/Reply text

(required)

"ReplyToID":

INT,

# ID of question replied or empty if is not reply

(required)

"NudgeCount":

INT,

# Nudge count ( how many times user nudged question )

(required)

"LastNudgeUnixTime":

INT,

# Unix timestamp when question last nudged

(required)

"LastNudgeTime":

"STRING"

# Printable time when question last time nudged

(required)

# Is quertion history only if option "QuestionsHistory=Y"

(required)

"DispatchTime":

{

"Code":

VALUES SET,

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(required)

"Label":

"STRING"

# Dispatch time information ( text ) as shown on eBid Listing pages

(required)

# Item dispatch time information

(required)

"ReturnPolicy":

{

"Code":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(required)

"Label":

"STRING"

# Return policy text

(required)

# Return policy information

(required)

"CategoryPath":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# opted by option "FullCategoryPath=Y"

(required)

"CategoryPath2":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# Category path for second category , if category present and query opted with 'FullCategoryPath=Y'

(required)

"RepostedIDs":

"STRING",

# If listing is closed and in request option RepostedIDs=Y was set , then it return comma separated list of ids of listings reposted from this one . Most recently reposted is first in the list .

(optional)

"Variations":

{

"ImageTag":

"STRING",

# Variation image tag

(required)

[

"Variation":

{

"Image":

{

"ImageLarge":

"STRING",

# Big image URL

(required)

"ImageSmall":

"STRING",

# Small image URL

(required)

"ImageMedium":

"STRING",

# Medium image URL

(required)

"eBidImage":

VALUES SET

# Is image stored at eBid servers ? Y/N

(required)

Y=yes | N=No

# Image info

(optional)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Variation price

(required)

"Quantity":

INT,

# Items quantity

(required)

"QuantitySold":

INT,

# Quantity already Sold

(required)

"Barcode":

"STRING",

# UPC/EAN/MPN code

(required)

"ItemSpecifics":

{

"Name":

"STRING",

# Attribute name

(required)

"Value":

"STRING"

# Attribute value

(required)

# Variation specifics

(required)

]

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING",

# Variation Maximum Price (added in 2.0)

(required)

"ItemSpecifics":

[{

"Name":

"STRING",

# Tag name

(required)

"Value":

"STRING"

# Tag value

(required)

}]

(required)

}

GetListingPreview
This method is similar to "SaveListingNew" but it does not put the listing live, it will check for errors and also return any eBid fees related to the listing of the item. This can be used before "SaveListingNew" to allow the user to check their listing and preview it.

API Command: GetListingPreview
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetListingPreview" ,

"LoginKey":

"STRING",

(required)

"CategoryID":

INT,

# Categry ID

(required)

"Title":

"STRING",

# Listing title

(required)

"Description":

"STRING",

# Listing description

(required)

"Quantity":

INT,

# Quantity to sel , max 99 items

(required)

"Duration":

{

"Days":

INT,

# Days

(required)

"Hours":

INT,

# Hours

(optional)

"Mins":

INT,

# Mins

(optional)

"AutoExtend":

VALUES SET,

# Y/N value . is listing autoextented when busy bids made near listing end

(optional)

Y=yes | N=No

"UntilSold":

VALUES SET

# Y/N value . Sell till sold . Days / hours then not need and StartListing Type tag must me 'immediatelly'

(optional)

Y=yes | N=No

# Listing duration

(optional)

"Duration":

INT,

# Is other way to specify duration - just days

(optional)

"StartBid":

DECIMAL,

# Starting price

(optional)

"ReservePrice":

DECIMAL,

# Reserve price . Multi-item listings does not have reserve price.

(optional)

"Feature":

VALUES SET,

# Listing feature : 'none' , 'special', 'gallery', 'platinum', 'standard' , 'front'

(optional)

"BuyNowPrice":

DECIMAL,

# Listing BuyNow price

(optional)

"Brand":

"STRING",

# Item brand like 'microsoft' , 'dell'

(optional)

"Store":

{

"StoreID":

INT,

# Store id where to list listing

(required)

"StoreCategory":

INT

# Store category id where list listing

(required)

(optional)

"AdultHide":

VALUES SET,

# Y/N value . If listing is adult , need hide bidder usernames.

(optional)

Y=yes | N=No

"ItemCondition":

VALUES SET,

# Item conditional , possible values : 'New','Used','Unused','Refurbished'

(optional)

n=New | u=Used | s=Unused | r=Refurbished | =Any

"Images":

{

"MainImage":

"STRING",

# URL to primary (thumbnail) image. This can be an eBid hosted image or alternatively an image from anywhere on the internet which we will then place into a queue for downloading to the eBid servers.

(required)

"Image":

["STRING"]

# URL to non-primary images. SELLER+ users are permitted 15 free images per listings. Can be an image already hosted on eBid servers or alternatively an image from the internet which we will upload to eBid servers.

(optional)

"Extras":

{

"Bold":

VALUES SET,

# Y/N value . Feature listing listing as bold .

(optional)

Y=yes | N=No

"Highlight":

VALUES SET,

# Y/N value . Highlight listing in results .

(optional)

Y=yes | N=No

"Images":

{

"Image":

["STRING"]

# URL to image . These images extra charged.

(required)

(optional)

"CategoryID":

"STRING",

# Second category ID for listing .

(optional)

"SubTitle":

"STRING"

# Listing subtitle

(optional)

# Listing extra features , similar to section four of ebid listing start form .

(optional)

"Movie":

"STRING",

# URL to video . 11 character YouTube id number for your movie .

(optional)

"SKU":

"STRING",

# Your SKU ( any value up to 100 chars )

(optional)

"NoReserve":

VALUES SET,

# Y/(empty value ) - listing have no reserve price . Alternative - just do not specify ReservePrice field

(optional)

Y=yes | N=No

"RepostCount":

INT,

# Number of auto reposts for this listing . 0-10 times.

(optional)

"StartListing":

{

"Type":

VALUES SET,

# Possible values : 'custom', 'onfirstbid' , 'immediate' . Custom require to set start time .Onfirst bid and immediatelly listings use duration from Duration field.

(required)

immediate=Immediate | onfirstbid=On firts bid | custom=Custom time

"Date":

"STRING"

# date when listing start , only for 'Custom' . Format is YYYY-MM-DD hh:mm:ss .

(required)

# Listing start time

(optional)

"Tax":

{

"State":

"STRING",

# State code like NY, FL etc

(required)

"Rate":

DECIMAL,

# Tax rate 0 - 99.9 percents.

(required)

"ApplyToShipping":

VALUES SET

# Y/N value - is tax applied also to shippings .

(required)

Y=yes | N=No

# Tax information ( only for countries that support tax calculations or error will return )

(optional)

"PaymentMethod":

"STRING",

# Comma separated payment methods codes . to retrieve all see query : GetPaymentOptionsValues .

(required)

"DomesticShippings":

{

"Type":

"STRING",

# possible values 'flat' ( fixed rates ) or 'calculated'( calculate by weight for some countries/services )

(required)

"DomesticShipping":

[{

"Price":

DECIMAL,

# Shipping price

(required)

"ShippingService":

"STRING",

# Shipping service eBid code , see query GetShippingOptionsValues , to retrieve all codes .

(required)

"ExtraItemPrice":

DECIMAL

# Price for 2nd item in the package , for multi item listings only and if price is different then 1nd item .

(required)

}],

# Flat domestic type input

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

INT,

(required)

"Y":

INT,

(required)

"Z":

INT

(required)

# Package sizes , not required for some postage methods

(optional)

"Weight":

{

"Lbs":

INT,

# Lbs or kg

(required)

"Oz":

INT

# Oz or gramms depend from site

(required)

# Package weight , in current sire weight units ( lb + oz , or kg + gramms )

(required)

"ExtraWeight":

{

"Lbs":

INT,

# Lbs or kg depend from site

(required)

"Oz":

INT

# Oz or gramms depend from site

(required)

# Weight for 2nd and next items for multi item listings and if weight different then 1st item .

(optional)

"PackageSize":

VALUES SET,

# eBid package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

[

"Option":

{

"ShippingService":

"STRING",

# Shipping service code , see query GetShippingOptionsValues to get all options

(required)

"Machinable":

VALUES SET,

# Y/N value , is package machinable ( required for some postage methods )

(optional)

Y=yes | N=No

"Rectangular":

VALUES SET,

# Y/N value is package rectangular . If so , then need set also Girth field.

(optional)

Y=yes | N=No

"Girth":

INT,

# Girth

(optional)

"FedexPackage":

VALUES SET

# fedex package eBid code

(required)

}

(required)

]

# Domestic shipping

(required)

"InternationalShippings":

{

"Type":

"STRING",

# 'flat' or 'calculated' , depend from type need read other fields. Calculated is for some services that can be calculated by weight .

(required)

"InternationalShipping":

[{

"Price":

DECIMAL,

# Shipping price

(required)

"ShippingService":

"STRING",

# eBid shipping service code . to see all codes - query : GetShippingOptionsValues

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list codes , like "uk,us,eu"

(required)

"ExtraItemPrice":

DECIMAL

# Price for shipping 2nd and next item for multi item listings and if shipping price is different then for 1nd item

(required)

}],

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

INT,

(required)

"Y":

INT,

(required)

"Z":

INT

(required)

# Package dimenstions . in inch or in cm depend from site measure units

(required)

"Weight":

{

"Lbs":

"STRING",

# Lbs or Kg depend from weight units

(required)

"Oz":

"STRING"

# Oz or gramms

(required)

# Package weight ( lbs + oz , or kg + gramms ) depend from site weight unit .

(required)

"ExtraWeight":

{

"Lbs":

INT,

# Lbs or kg depend from site weight units

(required)

"Oz":

INT

# Oz or gramms depend from site measure units

(required)

# Shipping weight for 2nd and next item in the package , only for multi item listings and if 2nd package weight is different from 1st .

(optional)

"PackageSize":

VALUES SET,

# eBid package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

[

"InternationalShipping":

{

"ShippingService":

"STRING",

# Shipping service code , to see all query : GetShippingOptionsValues

(required)

"AvailableTo":

VALUES SET,

# Comma separated country list to which shipping available like "uk,us,eu"

(required)

"Machinable":

VALUES SET,

# Y/N value , is package machinable , required for some shippings services only

(optional)

Y=yes | N=No

"Rectangular":

VALUES SET,

# Y/N value , is package rectangular , if so , then need specify also Girth

(optional)

Y=yes | N=No

"FedexPackage":

VALUES SET

# eBid Fedex package code ( fedex packages only )

(optional)

}

(required)

]

(optional)

"AcceptOffers":

VALUES SET,

# Y/N value , if seller accept offers for this listing

(optional)

Y=yes | N=No

"AutoOfferAcceptPrice":

DECIMAL,

# Auto accept offers price if seller accept offers .

(optional)

"AutoOfferDeclinePrice":

DECIMAL,

# Auto decline price if seller accept offers .

(optional)

"Barcode":

"STRING",

# Item EAN/UPC barcode , of special value 'exempt' if barcode not applicable for item ( unique , handmade , rarity )

(optional)

"ItemSpecificRaw":

"STRING",

# Item spcific attributes in eBid format ( color , sizes , etc )

(optional)

"DispatchTime":

VALUES SET,

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(optional)

"ReturnPolicy":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(optional)

"RepostListingID":

INT,

# If this listing is repost copy of some closed listing this field include original listing ID.

(optional)

"Currency":

"STRING",

# Currency code like USD , EUR

(optional)

[

"ItemSpecifics": # (added in 2.0)

{

"Name":

"STRING",

# Specifics tag name

(required)

"Value":

"STRING"

# Specifics Value

(required)

# (added in 2.0)

(optional)

]

"Variations": # (added in 2.0)

{

[

"Variation":

{

"Image":

["STRING"],

# Variation Image

(optional)

"Price":

DECIMAL,

# Variation Price

(required)

"Barcode":

"STRING",

# ISBN/UPC/EAN/MPN code

(optional)

"Quantity":

INT,

# Variation Quantity

(required)

[

"ItemSpecifics":

{

"Name":

"STRING",

# Specifics Tag name

(required)

"Value":

"STRING"

# Specifics value

(required)

# Variation Specifics

(required)

]

# Variation Data

(required)

]

}

# (added in 2.0)

(optional)

}

RESPONSE

{
"APIVersion": "",

"ListingFees":

{

"CurrencyCode":

VALUES SET,

# Currency ISO code like USD , EUR , etc

(required)

"CurrencySign":

"STRING",

# Currency HTML sign

(required)

"CurrencyName":

"STRING",

# Currency Name like 'US Dollars', 'Australian Dollars'

(required)

"CurrencyEmailSign":

"STRING"

# Cyrrency sign to print in texts & emails

(required)

# Listing fees

(required)

"Listing":

{

"ListingID":

INT,

# Listing ID

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Listing Seller data

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Listing category

(required)

"Category2":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Second category , if present or empty tag is not

(optional)

"Title":

"STRING",

# Listing title

(required)

"SubTitle":

"STRING",

# Listing subtitle ( if present )

(required)

"Bold":

VALUES SET,

# Y/N value , is listing bold

(required)

Y=yes | N=No

"Highlight":

VALUES SET,

# Y/N value , is listing highlighten in listings

(required)

Y=yes | N=No

"Movie":

"STRING",

# Listing movie ID

(required)

"Brand":

"STRING",

# Listing brand

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image large version ( or empty )

(required)

"PrimaryImageSmall":

"STRING",

# URL to Listing primary image small version or empty

(required)

"PrimaryImageMedium":

"STRING",

# URL to Listing primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N - Is image uploaded to eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N , is image is part of UPC/EAN library

(required)

"Quantity":

INT,

# Listing quantity ( 1 - max value )

(required)

"StartTime":

"STRING",

# Listing start time printable version

(required)

"StartTimeUnix":

INT,

# Start time , Unixtimestamp

(required)

"StartPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing Start price value

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"NextBid":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Next prossible bid or empty if not applicable

(required)

"Increment":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Increment value

(required)

"BidCount":

INT,

# Count of bids already made

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"BuyNowAvailable":

INT,

# Items quantity available for BuyNow

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price for this Listing

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price exchanged to local currency ( current country view )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price exchanged to current country currency

(required)

"Views":

INT,

# Listing views count ( how many it was viewed on eBid )

(required)

"Description":

"STRING",

# Listing Description

(required)

"Store":

{

"StoreID":

INT,

# Store ID

(required)

"Owner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Store owner

(required)

"Title":

"STRING",

# Store title ( name )

(required)

"Description":

"STRING",

# Store description

(required)

"Category":

INT,

# Store classification category ID ( ebid categories )

(required)

"Image":

"STRING",

# URL of store banner image

(required)

"ListingsCount":

INT,

# Count of listings in this store

(required)

"Link":

"STRING",

# URL to store ( link to eBid )

(required)

"Online":

VALUES SET

# Y/N value is store online

(required)

Y=yes | N=No

# Listing Store

(required)

"StoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Store category where listing listed ( or empty if not in store )

(required)

"ParentStoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Parent Store category where it listed or empty value

(required)

"AutoExtended":

VALUES SET,

# Y/N value , is autoextend set for Listing

(required)

Y=yes | N=No

"Barcode":

"STRING",

# UPC/EAN barcode code or empty value , or special value "EXEMPT"

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"ItemCondition":

{

"ID":

VALUES SET,

# Item condition id , n - new , u - used , s - unused , r - refurbished , '' - any

(required)

n=New | u=Used | s=Unused | r=Refurbished | =Any

"Name":

"STRING",

# Printable name of option

(required)

"APIName":

"STRING"

# API name to refer for API ( NEW , USED, UNUSED, REFURBISHED, ANY )

(required)

# Listing item condition

(required)

"PaymentOptions":

{

"PaymentOption":

[{

"ID":

INT,

# Option ID

(required)

"Name":

"STRING"

# Option name

(required)

}]

(required)

# Payment options available for listing

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"ShipTo":

VALUES SET,

# ISO country code for which current shipping price calculated

(required)

"ShipToName":

"STRING",

# Country name to which current shipping prices calculated

(required)

"ShipToZip":

"STRING",

# zip/postcode to which current shipping price calculated ( if required or present ).

(required)

"Shippings":

{

"DomesticShippings":

{

"Type":

"STRING",

# constant - "calculated"

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions (cm , or inch)

(required)

"Weight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Package weight ( for some countries is kg and gramms )

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

"STRING",

# Package girth ( inch )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Fedex package options or empty values

(optional)

}],

(required)

"PackageName":

"STRING"

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"DomesticShippings":

{

"Type":

"STRING",

# "flat" - is hardcoded , can be used to indefiny shipping type

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL

# Extra item shipping price ( if different then 1st item shipping price and if multi item listing )

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# shipping object type , hardcoded value "calculated"

(required)

"Handling":

DECIMAL,

# handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions ( in cm or inch depend from country )

(required)

"Weight":

{

"Lbs":

"STRING",

(required)

"Oz":

"STRING"

(required)

# Package weigh lb & oz or kg and gramms depend from country

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"PackageName":

"STRING",

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

DECIMAL,

# Package girth ( if applicable )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Options filled only if package is fedex

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# postage type , hardcoded value "flat"

(required)

"Option":

[{

"ShippingService":

"STRING",

# Postage service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL,

# Extra item shipping price ( if quantity more then 1 and shipping price is different then 1st item )

(required)

"AvailableTo":

VALUES SET

# Comma separated ISO country lists to which this shipping possible ( like "uk,us,de" )

(required)

}]

(required)

"Shipping":

{

"Code":

"STRING",

# Shipping method eBid code

(required)

"Name":

"STRING",

# Shipping method postage name ( like Royal Mail 1st Class , Parcelforce (2 Day Delivery) , etc )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"PriceExchanged":

"STRING",

# Shipping price exchanged to current site currency

(required)

"Calculated":

"STRING",

# Y/N - is price received from postage service provider ( N - defined directly by user )

(required)

"ShippingTo":

"STRING",

# ISO Country code for this shipping price ( like uk , us, etc )

(required)

"ShippingToName":

"STRING",

# Country Name for this shipping price ( like United States , Canada , etc )

(required)

"ExtraDetails":

"STRING"

# Extar details for this postage method ( Not available or to be calculated ) , can replace price by this text

(required)

}

(required)

# Listing shipping data . Depend from parameters and listing shipping data this tag may include different optional shipping parameters.

(required)

"MinShippingCost":

"STRING",

# Minimal shipping cost for this listing to choosed or default country

(required)

"MinShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"MinShippingCostName":

"STRING",

# Minimal shipping cost postage method ( printable label like "Royal Mail Airmail" ...)

(required)

"UserListingsCount":

INT,

# Listings count for this listing , is optional depend from parameters.

(optional)

"ShipZipRequiredDom":

VALUES SET,

# Y/(empty value) , is zip postacode required to calculate Domestic shipping prices

(required)

Y=Yes | =No (empty value)

"ShipZipRequiredInt":

VALUES SET,

# Y/(empty value) is zip/postcode required to calculate international price

(required)

Y=Yes | =No (empty value)

"Bids":

{

"Bid":

[{

"BidID":

INT,

# Bid ID

(required)

"BuyNow":

VALUES SET,

# Y/(empty value) - is this buynow bid record

(required)

Y=Yes | =No (empty value)

"UserID":

INT,

# Bidder UserID ( possible 0 - when name hidden , adult listings)

(required)

"Username":

"STRING",

# Bidder username

(required)

"UnixTime":

"STRING",

# Unix Timestamp when bid made

(required)

"Amount":

"STRING",

# Bid amount , possible value "Not Public" for non public values

(required)

"Allocation":

INT,

# Quandtity allocated by this bid ( for dutch listings possible less then quantity )

(required)

"Quantity":

INT,

# Bid quantity

(required)

"QuantityText":

"STRING",

# Printable bid quantity , use to output

(required)

"Time":

"STRING",

# Printable bid time

(required)

"MAO":

VALUES SET,

# Y/(empty value) - is bid generated by successful offer

(required)

Y=Yes | =No (empty value)

"IconType":

VALUES SET,

# Bid icon type - p, r, b ( proxy , reserve meet , buynow )

(required)

p=Proxy | r=Reserve meet | b=Buynow

"IconImages":

"STRING",

# Icon images tags , include IMG tage , possible few together.

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Bidder user object , may not be here if private listing , or can be full version if some params present.

(optional)

"HiddenName":

VALUES SET,

# Y/(empty value) - is name hidden

(required)

Y=Yes | =No (empty value)

"NotPublic":

VALUES SET,

# Y/(empty value) - is amount public or no

(required)

Y=Yes | =No (empty value)

"BuyerFullInfo":

VALUES SET

# Y/(empty value) - is User tag include full version of user object

(required)

Y=Yes | =No (empty value)

}]

(required)

# Bids history for this listing , only if it required in initial query , or empty value

(required)

"Type":

VALUES SET,

# "n" or "d" char , Listing type n-single item listing , d - multi item listing

(required)

n=Single item listing | d=Multi item listing

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing/listing price

(required)

"AdultHiddenName":

[{

"UserID":

INT,

# UserID

(required)

"Username":

"STRING"

# Hidden name replacement like "hiddenname1"

(required)

}],

(required)

"AdultHide":

"STRING",

# Y/N value - is listing opted as Adult Hide Usernames

(required)

"ItemsAvailableBid":

INT,

# Quantity available to bid . If holiday notice set - bidding is not available .

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empy value) - is bidding available for this listing now . Do not show bid form if this field is not set to Y.

(required)

Y=Yes | =No (empty value)

"HolidayNotice":

VALUES SET,

# Y/N value . Is User notice is holiday ( user is on vacancy , and bidding not available )

(required)

Y=yes | N=No

"HolidayNoticeText":

"STRING",

# Holiday notice text , If notify is present then user text or empty.

(required)

"Watch":

VALUES SET,

# Y/N value , is current user watching this listing , only if login info sent with request .

(required)

Y=yes | N=No

"ListingStateSuccess":

VALUES SET,

# Y/N value , is this listing for current user is success ( high bidder , buyed via buynow ) , empty value if user login info not sent with query

(required)

Y=yes | N=No

"ListingStateMessage":

"STRING",

# Listing status message normally shown on eBid listing page at top , only for logged in users ( if login info sent with query )

(required)

"ListingQuestionState":

"STRING",

# Listing question state , only if login data sent with this query e.q. for logged info only . Or empty.

(required)

"Live":

VALUES SET,

# Y/(empty value) - is listing live , e.q. running . listing is live while it not moved to myeBid closed area ( not just time expired ).

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/N value - Is seller accept offers for this listing .

(required)

Y=yes | N=No

"OffersStatus":

"STRING",

# Offers status normally shown at top of eBid listing page , is not empty if seller accept offers , some offer made , and user logged in ( logged info sent with query )

(required)

"OffersAttentionRequired":

VALUES SET,

# Y/N value , is current offers required logged user attention . For example seller attention required when offers made . Is set only if logged user info provided with query.

(required)

Y=yes | N=No

"OffersHistoryCount":

INT,

# How many offers made for this listing/listing

(required)

"PrimaryMarket":

VALUES SET,

# Primary market ISO country code like "us" , "uk" , "eu" ...

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list like "us,uk,eu" or similar . Listing is available on these eBid markets .

(required)

"ASL":

[{

"Sale":

{

"SaleID":

INT,

# Sale ID

(required)

"Buyer":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Buyer info

(required)

"UnixTime":

INT,

# Unix Timestamp when sale made

(required)

"Time":

"STRING",

# Printable when sale made

(required)

"PurchasePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price

(required)

"PurchasePriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price exchanged to current country currency

(required)

"Quantity":

INT,

# Quantity of items purchased

(required)

"ShippingPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"ShippingPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price exchanged to current country currency

(required)

"TotalAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Total sale amount

(required)

"TotalAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total Amount exchanged to current country currency

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

}

# Items Seller object

(required)

"Status":

{

"InvoiceStatus":

VALUES SET,

# Y/N value is invoice sent

(required)

Y=yes | N=No

"InvoiceStatusText":

"STRING",

# is invoice sent - Yes/No text status

(required)

"PaymentStatus":

VALUES SET,

# C/R/NP/Y/YN/N values where C - Cancelled, R - Refunded, NP - Non Payed , Y - Payed, YN - Pending , N - Not Yet

(required)

"PaymentStatusText":

"STRING",

# Payment status printable text - Cancelled / Refunded / Non Payed / Payed / Pending / Not Yet

(required)

"ShipmentStatus":

VALUES SET,

# Y/N/C - is item shipped - yes , no , cancelled

(required)

Y=Shipped | N=Not Shipped | C=Cancelled

"ShipmentStatusText":

"STRING",

# text value for shipment status - Yes / No / Cancelled

(required)

"FeedbackLeftStatus":

VALUES SET,

# Is feedback left by current user - Y/N/C - Yes, No , Cancelled

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackLeftStatusText":

"STRING",

# Is feedback leaved by current user - Yes / No / Cancelled

(required)

"FeedbackReceivedStatus":

VALUES SET,

# Y/N/C - is current user received feedback for this item ( Yes / No / Cancelled )

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackReceivedStatusText":

"STRING"

# printable feedback received for this item status - Yes / No / Cancelled

(required)

"AvailableOptions":

{

"Option":

[{

"ID":

INT,

# ASL option ID

(required)

"Code":

VALUES SET,

# ASL string code like (PayNowViaPPPay, RequestInvoiceFromSeller ...) , use this to make all checks in code.

(required)

"Text":

"STRING",

# Option title ( use to show on screen as choose option )

(required)

"ExtraParam":

"STRING",

# Some extra params for option , currently used only for question reply and include question ID .

(required)

"TextNeed":

VALUES SET

(required)

Y=user required enter text | N=text is not need | C=option cannot be submit

}]

(required)

# Available after sale actions

(required)

"Log":

{

"Message":

[{

"ID":

INT,

# ASL log entry ID

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# ASL log user ( who logged )

(required)

"UnixTime":

INT,

# Unix timestamp when entry added

(required)

"Time":

"STRING",

# Printable time when log entry added

(required)

"Type":

VALUES SET,

# A numeric value relating to the type of ASL entry.

(required)

"TextType":

"STRING",

# Log entry type ( printable text )

(required)

"Details":

"STRING",

# Log entry message ( entered by user or generated )

(required)

"ReplyTo":

INT,

# ReplyID to some other log entry ( only for questions replies )

(required)

"NudgeCount":

INT,

# Nudge count ( questions only )

(required)

"LastNudgeUnixTime":

INT,

# Unix Timestamp of last nudge ( questions only )

(required)

"LastNudge":

"STRING",

# Last nudge time ( printable format )

(required)

"FeedbackMessage":

"STRING"

# Feedback message ( only for feedbacks )

(required)

}]

(required)

# ASL Log entry

(required)

}],

(required)

"ReservePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing reserve price .

(required)

"AutoOfferAcceptPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers auto accept price

(required)

"AutoOfferDeclinePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers Auto decline price

(required)

"ToRepostCount":

INT,

# Count of autoreposts still due for this listing

(required)

"ToRepostOriginalCount":

INT,

# Initial value of count of listing autoreposts

(required)

"BuynowDiscount":

DECIMAL,

# Current buynow discount rate , is percent from 0 to 99.9

(required)

"ItemSpecificRaw":

"STRING",

# Item specific string , color , sizes , etc . Same format as for bulk upload .

(required)

"Duration":

{

"Days":

INT,

# Days

(required)

"Hours":

INT,

# Hours , available to Seller+ accounts only

(required)

"Mins":

INT,

# Mins , available for Seller+ accounts only

(required)

"UntilSold":

VALUES SET,

# Y/(empty value ) is this listing is Run Until Sold , if so then Days/Hours/Mins is empty

(required)

Y=Yes | =No (empty value)

"AutoExtend":

VALUES SET

# Y/N value , is listing auto extended when busy bids made.

(required)

Y=yes | N=No

# Original listing duration

(required)

"StartListing":

{

"Type":

VALUES SET

# Listing start options : "immediately" , "onfirstbid"

(required)

immediate=Immediate | onfirstbid=On firts bid | custom=Custom time

# Listing start information

(required)

"Tax":

[{

"State":

"STRING",

# Tax state code ( like NY, FL etc )

(required)

"Rate":

DECIMAL,

# Tax rate ( percent )

(required)

"ApplyToShipping":

VALUES SET

# Y/(empty value) - is tax applied to shipping also

(required)

Y=Yes | =No (empty value)

}],

(required)

"URL":

"STRING",

# Listing URL pointed to eBid listing page

(required)

"QuestionsCount":

INT,

# Questions count or empty value. Questions count provided only with options "QuestionsCount=Y" or "QuestionsHistory=Y"

(required)

"Questions":

{

"QuestionID":

INT,

# Question ID

(required)

"ListingID":

INT,

# Listing ID

(required)

"Poster":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Question poster ( user object )

(required)

"UnixTime":

INT,

# Unixtimestamp time when question/reply posted

(required)

"Time":

"STRING",

# Printable question/reply time

(required)

"Message":

"STRING",

# Question/Reply text

(required)

"ReplyToID":

INT,

# ID of question replied or empty if is not reply

(required)

"NudgeCount":

INT,

# Nudge count ( how many times user nudged question )

(required)

"LastNudgeUnixTime":

INT,

# Unix timestamp when question last nudged

(required)

"LastNudgeTime":

"STRING"

# Printable time when question last time nudged

(required)

# Is quertion history only if option "QuestionsHistory=Y"

(required)

"DispatchTime":

{

"Code":

VALUES SET,

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(required)

"Label":

"STRING"

# Dispatch time information ( text ) as shown on eBid Listing pages

(required)

# Item dispatch time information

(required)

"ReturnPolicy":

{

"Code":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(required)

"Label":

"STRING"

# Return policy text

(required)

# Return policy information

(required)

"CategoryPath":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# opted by option "FullCategoryPath=Y"

(required)

"CategoryPath2":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# Category path for second category , if category present and query opted with 'FullCategoryPath=Y'

(required)

"RepostedIDs":

"STRING",

# If listing is closed and in request option RepostedIDs=Y was set , then it return comma separated list of ids of listings reposted from this one . Most recently reposted is first in the list .

(optional)

"Variations":

{

"ImageTag":

"STRING",

# Variation image tag

(required)

[

"Variation":

{

"Image":

{

"ImageLarge":

"STRING",

# Big image URL

(required)

"ImageSmall":

"STRING",

# Small image URL

(required)

"ImageMedium":

"STRING",

# Medium image URL

(required)

"eBidImage":

VALUES SET

# Is image stored at eBid servers ? Y/N

(required)

Y=yes | N=No

# Image info

(optional)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Variation price

(required)

"Quantity":

INT,

# Items quantity

(required)

"QuantitySold":

INT,

# Quantity already Sold

(required)

"Barcode":

"STRING",

# UPC/EAN/MPN code

(required)

"ItemSpecifics":

{

"Name":

"STRING",

# Attribute name

(required)

"Value":

"STRING"

# Attribute value

(required)

# Variation specifics

(required)

]

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING",

# Variation Maximum Price (added in 2.0)

(required)

"ItemSpecifics":

[{

"Name":

"STRING",

# Tag name

(required)

"Value":

"STRING"

# Tag value

(required)

}]

(required)

}

(required)

}

GetListingPreviewEdit
This method is very similar to "SaveListingEdit", but it doest not save the changed data but previews it for errors allowing user to confirm changes.

API Command: GetListingPreviewEdit
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetListingPreviewEdit" ,

"LoginKey":

"STRING",

# User Login Key

(optional)

"ListingID":

"STRING",

# Listing ID to edit

(required)

"Title":

"STRING",

# Listing title

(optional)

"Description":

"STRING",

# Listing description

(optional)

"StartBid":

DECIMAL,

# Listing starting price , only if bids not made yet.

(optional)

"BuyNowPrice":

DECIMAL,

# Buy Now price . If bids not made yet.

(optional)

"ReservePrice":

DECIMAL,

# Reserver price , can be updated if no bids already made.

(optional)

"CategoryID":

INT,

# Listing category ID

(optional)

"Barcode":

"STRING",

# Item EAN/UPC barcode , of special value 'exempt' if barcode not applicable for item ( unique , handmade , rarity )

(optional)

"Quantity":

INT,

# Quantity to sel , max 99 items

(optional)

"DispatchTime":

"STRING",

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(required)

"ReturnPolicy":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(optional)

"Store":

{

"StoreID":

INT,

# Store id where to list listing

(optional)

"StoreCategory":

"STRING"

# Store category id where list listing

(required)

(optional)

"AdultHide":

"STRING",

# Y/N value . If listing is adult , need hide bidder usernames.

(optional)

"Duration":

{

"Days":

"STRING",

# Days

(required)

"Hours":

"STRING",

# Hours

(optional)

"Mins":

INT,

# Mins

(optional)

"AutoExtend":

"STRING",

# Y/N value . is listing autoextented when busy bids made near listing end

(optional)

"UntilSold":

"STRING"

# Y/N value . Sell till sold . Days / hours then not need and StartListing Type tag must me 'immediatelly'

(optional)

# Listing duration

(optional)

"Duration":

INT,

# Alternative duration define , just as days

(optional)

"RepostCount":

INT,

# Number of auto reposts for this listing . 0-10 times.

(optional)

"Movie":

"STRING",

# URL to video . 11 character YouTube id number for your movie .

(optional)

"SKU":

"STRING",

# Your SKU ( any value up to 100 chars )

(optional)

"AcceptOffers":

"STRING",

# Y/N value , if seller accept offers for this listing

(optional)

"AutoOfferAcceptPrice":

DECIMAL,

# Auto accept offers price if seller accept offers .

(optional)

"AutoOfferDeclinePrice":

"STRING",

# Auto decline price if seller accept offers .

(optional)

"Feature":

"STRING",

# Listing feature : 'none' , 'special', 'gallery', 'platinum', 'standard' , 'front'

(optional)

"Extras":

{

"Bold":

"STRING",

# Y/N value . Feature listing listing as bold .

(optional)

"Highlight":

"STRING",

# Y/N value . Highlight listing in results .

(optional)

"Images":

{

"Image":

["STRING"]

# URL to image . These images extra charged.

(required)

"CategoryID":

INT,

# Second category ID for listing .

(optional)

"SubTitle":

"STRING"

# Listing subtitle

(optional)

# Extra payable listing features

(optional)

"DomesticShippings":

{

"Type":

"STRING",

# possible values 'flat' ( fixed rates ) or 'calculated'( calculate by weight for some countries/services )

(required)

"DomesticShipping":

[{

"Price":

DECIMAL,

# Shipping price

(required)

"ShippingService":

"STRING",

# Shipping service eBid code , see query GetShippingOptionsValues , to retrieve all codes .

(required)

"ExtraItemPrice":

DECIMAL

# Price for 2nd item in the package , for multi item listings only and if price is different then 1nd item .

(required)

}],

# Flat domestic type input

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

INT,

(required)

"Y":

INT,

(required)

"Z":

INT

(required)

# Package sizes , not required for some postage methods

(optional)

"Weight":

{

"Lbs":

INT,

# Lbs or kg

(required)

"Oz":

INT

# Oz or gramms depend from site

(required)

# Package weight , in current sire weight units ( lb + oz , or kg + gramms )

(required)

"ExtraWeight":

{

"Lbs":

INT,

# Lbs or kg depend from site

(required)

"Oz":

INT

# Oz or gramms depend from site

(required)

# Weight for 2nd and next items for multi item listings and if weight different then 1st item .

(optional)

"PackageSize":

VALUES SET,

# eBid package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

[

"Option":

{

"ShippingService":

"STRING",

# Shipping service code , see query GetShippingOptionsValues to get all options

(required)

"Machinable":

VALUES SET,

# Y/N value , is package machinable ( required for some postage methods )

(optional)

Y=yes | N=No

"Rectangular":

VALUES SET,

# Y/N value is package rectangular . If so , then need set also Girth field.

(optional)

Y=yes | N=No

"Girth":

INT,

# Girth

(optional)

"FedexPackage":

VALUES SET

# fedex package eBid code

(required)

}

(required)

]

(optional)

"InternationalShippings":

{

"Type":

"STRING",

# 'flat' or 'calculated' , depend from type need read other fields. Calculated is for some services that can be calculated by weight .

(required)

"InternationalShipping":

[{

"Price":

DECIMAL,

# Shipping price

(required)

"ShippingService":

"STRING",

# eBid shipping service code . to see all codes - query : GetShippingOptionsValues

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list codes , like "uk,us,eu"

(required)

"ExtraItemPrice":

DECIMAL

# Price for shipping 2nd and next item for multi item listings and if shipping price is different then for 1nd item

(required)

}],

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

INT,

(required)

"Y":

INT,

(required)

"Z":

INT

(required)

# Package dimenstions . in inch or in cm depend from site measure units

(required)

"Weight":

{

"Lbs":

"STRING",

# Lbs or Kg depend from weight units

(required)

"Oz":

"STRING"

# Oz or gramms

(required)

# Package weight ( lbs + oz , or kg + gramms ) depend from site weight unit .

(required)

"ExtraWeight":

{

"Lbs":

INT,

# Lbs or kg depend from site weight units

(required)

"Oz":

INT

# Oz or gramms depend from site measure units

(required)

# Shipping weight for 2nd and next item in the package , only for multi item listings and if 2nd package weight is different from 1st .

(optional)

"PackageSize":

VALUES SET,

# eBid package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

[

"InternationalShipping":

{

"ShippingService":

"STRING",

# Shipping service code , to see all query : GetShippingOptionsValues

(required)

"AvailableTo":

VALUES SET,

# Comma separated country list to which shipping available like "uk,us,eu"

(required)

"Machinable":

VALUES SET,

# Y/N value , is package machinable , required for some shippings services only

(optional)

Y=yes | N=No

"Rectangular":

VALUES SET,

# Y/N value , is package rectangular , if so , then need specify also Girth

(optional)

Y=yes | N=No

"FedexPackage":

VALUES SET

# eBid Fedex package code ( fedex packages only )

(optional)

}

(required)

]

# International shippings

(optional)

"PaymentMethod":

"STRING",

# Comma separated payment methods codes . to retrieve all see query : GetPaymentOptionsValues .

(optional)

"ItemCondition":

"STRING",

# Item conditional , possible values : 'New','Used','Unused','Refurbished'

(optional)

"Brand":

"STRING",

# Item brand like 'microsoft' , 'dell'

(optional)

"Tax":

{

"State":

"STRING",

# State code like NY, FL etc

(required)

"Rate":

"STRING",

# Tax rate 0 - 99.9 percents.

(required)

"ApplyToShipping":

"STRING"

# Y/N value - is tax applied also to shippings .

(required)

# Tax information ( only for countries that support tax calculations or error will return )

(optional)

"BuynowDiscount":

DECIMAL,

# Buynow discount percent .

(optional)

"BuynowDiscountLength":

INT,

# Buy now dicount length , depend from BuynowDiscountType field is hours or days

(optional)

"BuynowDiscountType":

"STRING",

# 'hrs' or 'days' - buynow discount length

(optional)

"PostageCode":

"STRING",

# Postage Shipping Code

(optional)

"StartListing":

{

"Type":

"STRING",

# Possible values : 'custom', 'onfirstbid' , 'immediately' . Custom require to set start time .Onfirst bid and immediatelly listings use duration from Duration field.

(required)

"Date":

"STRING"

# date when listing start , only for 'Custom' . Format is YYYY-MM-DD hh:mm:ss .

(required)

# Listing start time

(optional)

"Images":

{

"MainImage":

"STRING",

# URL to main ( primary ) image . For gallery and other featured listings image must be uploaded to eBid servers before it use. For featured listings isn't enough just point URL to your image in this field.

(required)

"Image":

["STRING"]

# URL to image . can be multiple images following eBid rules.

(optional)

"ItemSpecificRaw":

"STRING",

# Item spcific attributes in eBid format ( color , sizes , etc )

(optional)

"Variations": # (added in 2.0)

{

[

"Variation":

{

"Image":

["STRING"],

# Variation Image

(optional)

"Price":

DECIMAL,

# Variation Price

(required)

"Barcode":

"STRING",

# ISBN/UPC/EAN/MPN code

(optional)

"Quantity":

INT,

# Variation Quantity

(required)

[

"ItemSpecifics":

{

"Name":

"STRING",

# Specifics Tag name

(required)

"Value":

"STRING"

# Specifics value

(required)

# Variation Specifics

(required)

]

(required)

]

# (added in 2.0)

(optional)

[

"ItemSpecifics": # (added in 2.0)

{

"Name":

"STRING",

# Specifics tag name

(required)

"Value":

"STRING"

# Specifics Value

(required)

# (added in 2.0)

(optional)

]

}

RESPONSE

{
"APIVersion": "",

"Listing":

{

"ListingID":

INT,

# Listing ID

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Listing Seller data

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Listing category

(required)

"Category2":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Second category , if present or empty tag is not

(optional)

"Title":

"STRING",

# Listing title

(required)

"SubTitle":

"STRING",

# Listing subtitle ( if present )

(required)

"Bold":

VALUES SET,

# Y/N value , is listing bold

(required)

Y=yes | N=No

"Highlight":

VALUES SET,

# Y/N value , is listing highlighten in listings

(required)

Y=yes | N=No

"Movie":

"STRING",

# Listing movie ID

(required)

"Brand":

"STRING",

# Listing brand

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image large version ( or empty )

(required)

"PrimaryImageSmall":

"STRING",

# URL to Listing primary image small version or empty

(required)

"PrimaryImageMedium":

"STRING",

# URL to Listing primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N - Is image uploaded to eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N , is image is part of UPC/EAN library

(required)

"Quantity":

INT,

# Listing quantity ( 1 - max value )

(required)

"StartTime":

"STRING",

# Listing start time printable version

(required)

"StartTimeUnix":

INT,

# Start time , Unixtimestamp

(required)

"StartPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing Start price value

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"NextBid":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Next prossible bid or empty if not applicable

(required)

"Increment":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Increment value

(required)

"BidCount":

INT,

# Count of bids already made

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"BuyNowAvailable":

INT,

# Items quantity available for BuyNow

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price for this Listing

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price exchanged to local currency ( current country view )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price exchanged to current country currency

(required)

"Views":

INT,

# Listing views count ( how many it was viewed on eBid )

(required)

"Description":

"STRING",

# Listing Description

(required)

"Store":

{

"StoreID":

INT,

# Store ID

(required)

"Owner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Store owner

(required)

"Title":

"STRING",

# Store title ( name )

(required)

"Description":

"STRING",

# Store description

(required)

"Category":

INT,

# Store classification category ID ( ebid categories )

(required)

"Image":

"STRING",

# URL of store banner image

(required)

"ListingsCount":

INT,

# Count of listings in this store

(required)

"Link":

"STRING",

# URL to store ( link to eBid )

(required)

"Online":

VALUES SET

# Y/N value is store online

(required)

Y=yes | N=No

# Listing Store

(required)

"StoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Store category where listing listed ( or empty if not in store )

(required)

"ParentStoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Parent Store category where it listed or empty value

(required)

"AutoExtended":

VALUES SET,

# Y/N value , is autoextend set for Listing

(required)

Y=yes | N=No

"Barcode":

"STRING",

# UPC/EAN barcode code or empty value , or special value "EXEMPT"

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"ItemCondition":

{

"ID":

VALUES SET,

# Item condition id , n - new , u - used , s - unused , r - refurbished , '' - any

(required)

n=New | u=Used | s=Unused | r=Refurbished | =Any

"Name":

"STRING",

# Printable name of option

(required)

"APIName":

"STRING"

# API name to refer for API ( NEW , USED, UNUSED, REFURBISHED, ANY )

(required)

# Listing item condition

(required)

"PaymentOptions":

{

"PaymentOption":

[{

"ID":

INT,

# Option ID

(required)

"Name":

"STRING"

# Option name

(required)

}]

(required)

# Payment options available for listing

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"ShipTo":

VALUES SET,

# ISO country code for which current shipping price calculated

(required)

"ShipToName":

"STRING",

# Country name to which current shipping prices calculated

(required)

"ShipToZip":

"STRING",

# zip/postcode to which current shipping price calculated ( if required or present ).

(required)

"Shippings":

{

"DomesticShippings":

{

"Type":

"STRING",

# constant - "calculated"

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions (cm , or inch)

(required)

"Weight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Package weight ( for some countries is kg and gramms )

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

"STRING",

# Package girth ( inch )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Fedex package options or empty values

(optional)

}],

(required)

"PackageName":

"STRING"

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"DomesticShippings":

{

"Type":

"STRING",

# "flat" - is hardcoded , can be used to indefiny shipping type

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL

# Extra item shipping price ( if different then 1st item shipping price and if multi item listing )

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# shipping object type , hardcoded value "calculated"

(required)

"Handling":

DECIMAL,

# handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions ( in cm or inch depend from country )

(required)

"Weight":

{

"Lbs":

"STRING",

(required)

"Oz":

"STRING"

(required)

# Package weigh lb & oz or kg and gramms depend from country

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"PackageName":

"STRING",

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

DECIMAL,

# Package girth ( if applicable )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Options filled only if package is fedex

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# postage type , hardcoded value "flat"

(required)

"Option":

[{

"ShippingService":

"STRING",

# Postage service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL,

# Extra item shipping price ( if quantity more then 1 and shipping price is different then 1st item )

(required)

"AvailableTo":

VALUES SET

# Comma separated ISO country lists to which this shipping possible ( like "uk,us,de" )

(required)

}]

(required)

"Shipping":

{

"Code":

"STRING",

# Shipping method eBid code

(required)

"Name":

"STRING",

# Shipping method postage name ( like Royal Mail 1st Class , Parcelforce (2 Day Delivery) , etc )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"PriceExchanged":

"STRING",

# Shipping price exchanged to current site currency

(required)

"Calculated":

"STRING",

# Y/N - is price received from postage service provider ( N - defined directly by user )

(required)

"ShippingTo":

"STRING",

# ISO Country code for this shipping price ( like uk , us, etc )

(required)

"ShippingToName":

"STRING",

# Country Name for this shipping price ( like United States , Canada , etc )

(required)

"ExtraDetails":

"STRING"

# Extar details for this postage method ( Not available or to be calculated ) , can replace price by this text

(required)

}

(required)

# Listing shipping data . Depend from parameters and listing shipping data this tag may include different optional shipping parameters.

(required)

"MinShippingCost":

"STRING",

# Minimal shipping cost for this listing to choosed or default country

(required)

"MinShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"MinShippingCostName":

"STRING",

# Minimal shipping cost postage method ( printable label like "Royal Mail Airmail" ...)

(required)

"UserListingsCount":

INT,

# Listings count for this listing , is optional depend from parameters.

(optional)

"ShipZipRequiredDom":

VALUES SET,

# Y/(empty value) , is zip postacode required to calculate Domestic shipping prices

(required)

Y=Yes | =No (empty value)

"ShipZipRequiredInt":

VALUES SET,

# Y/(empty value) is zip/postcode required to calculate international price

(required)

Y=Yes | =No (empty value)

"Bids":

{

"Bid":

[{

"BidID":

INT,

# Bid ID

(required)

"BuyNow":

VALUES SET,

# Y/(empty value) - is this buynow bid record

(required)

Y=Yes | =No (empty value)

"UserID":

INT,

# Bidder UserID ( possible 0 - when name hidden , adult listings)

(required)

"Username":

"STRING",

# Bidder username

(required)

"UnixTime":

"STRING",

# Unix Timestamp when bid made

(required)

"Amount":

"STRING",

# Bid amount , possible value "Not Public" for non public values

(required)

"Allocation":

INT,

# Quandtity allocated by this bid ( for dutch listings possible less then quantity )

(required)

"Quantity":

INT,

# Bid quantity

(required)

"QuantityText":

"STRING",

# Printable bid quantity , use to output

(required)

"Time":

"STRING",

# Printable bid time

(required)

"MAO":

VALUES SET,

# Y/(empty value) - is bid generated by successful offer

(required)

Y=Yes | =No (empty value)

"IconType":

VALUES SET,

# Bid icon type - p, r, b ( proxy , reserve meet , buynow )

(required)

p=Proxy | r=Reserve meet | b=Buynow

"IconImages":

"STRING",

# Icon images tags , include IMG tage , possible few together.

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Bidder user object , may not be here if private listing , or can be full version if some params present.

(optional)

"HiddenName":

VALUES SET,

# Y/(empty value) - is name hidden

(required)

Y=Yes | =No (empty value)

"NotPublic":

VALUES SET,

# Y/(empty value) - is amount public or no

(required)

Y=Yes | =No (empty value)

"BuyerFullInfo":

VALUES SET

# Y/(empty value) - is User tag include full version of user object

(required)

Y=Yes | =No (empty value)

}]

(required)

# Bids history for this listing , only if it required in initial query , or empty value

(required)

"Type":

VALUES SET,

# "n" or "d" char , Listing type n-single item listing , d - multi item listing

(required)

n=Single item listing | d=Multi item listing

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing/listing price

(required)

"AdultHiddenName":

[{

"UserID":

INT,

# UserID

(required)

"Username":

"STRING"

# Hidden name replacement like "hiddenname1"

(required)

}],

(required)

"AdultHide":

"STRING",

# Y/N value - is listing opted as Adult Hide Usernames

(required)

"ItemsAvailableBid":

INT,

# Quantity available to bid . If holiday notice set - bidding is not available .

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empy value) - is bidding available for this listing now . Do not show bid form if this field is not set to Y.

(required)

Y=Yes | =No (empty value)

"HolidayNotice":

VALUES SET,

# Y/N value . Is User notice is holiday ( user is on vacancy , and bidding not available )

(required)

Y=yes | N=No

"HolidayNoticeText":

"STRING",

# Holiday notice text , If notify is present then user text or empty.

(required)

"Watch":

VALUES SET,

# Y/N value , is current user watching this listing , only if login info sent with request .

(required)

Y=yes | N=No

"ListingStateSuccess":

VALUES SET,

# Y/N value , is this listing for current user is success ( high bidder , buyed via buynow ) , empty value if user login info not sent with query

(required)

Y=yes | N=No

"ListingStateMessage":

"STRING",

# Listing status message normally shown on eBid listing page at top , only for logged in users ( if login info sent with query )

(required)

"ListingQuestionState":

"STRING",

# Listing question state , only if login data sent with this query e.q. for logged info only . Or empty.

(required)

"Live":

VALUES SET,

# Y/(empty value) - is listing live , e.q. running . listing is live while it not moved to myeBid closed area ( not just time expired ).

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/N value - Is seller accept offers for this listing .

(required)

Y=yes | N=No

"OffersStatus":

"STRING",

# Offers status normally shown at top of eBid listing page , is not empty if seller accept offers , some offer made , and user logged in ( logged info sent with query )

(required)

"OffersAttentionRequired":

VALUES SET,

# Y/N value , is current offers required logged user attention . For example seller attention required when offers made . Is set only if logged user info provided with query.

(required)

Y=yes | N=No

"OffersHistoryCount":

INT,

# How many offers made for this listing/listing

(required)

"PrimaryMarket":

VALUES SET,

# Primary market ISO country code like "us" , "uk" , "eu" ...

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list like "us,uk,eu" or similar . Listing is available on these eBid markets .

(required)

"ASL":

[{

"Sale":

{

"SaleID":

INT,

# Sale ID

(required)

"Buyer":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Buyer info

(required)

"UnixTime":

INT,

# Unix Timestamp when sale made

(required)

"Time":

"STRING",

# Printable when sale made

(required)

"PurchasePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price

(required)

"PurchasePriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price exchanged to current country currency

(required)

"Quantity":

INT,

# Quantity of items purchased

(required)

"ShippingPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"ShippingPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price exchanged to current country currency

(required)

"TotalAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Total sale amount

(required)

"TotalAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total Amount exchanged to current country currency

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

}

# Items Seller object

(required)

"Status":

{

"InvoiceStatus":

VALUES SET,

# Y/N value is invoice sent

(required)

Y=yes | N=No

"InvoiceStatusText":

"STRING",

# is invoice sent - Yes/No text status

(required)

"PaymentStatus":

VALUES SET,

# C/R/NP/Y/YN/N values where C - Cancelled, R - Refunded, NP - Non Payed , Y - Payed, YN - Pending , N - Not Yet

(required)

"PaymentStatusText":

"STRING",

# Payment status printable text - Cancelled / Refunded / Non Payed / Payed / Pending / Not Yet

(required)

"ShipmentStatus":

VALUES SET,

# Y/N/C - is item shipped - yes , no , cancelled

(required)

Y=Shipped | N=Not Shipped | C=Cancelled

"ShipmentStatusText":

"STRING",

# text value for shipment status - Yes / No / Cancelled

(required)

"FeedbackLeftStatus":

VALUES SET,

# Is feedback left by current user - Y/N/C - Yes, No , Cancelled

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackLeftStatusText":

"STRING",

# Is feedback leaved by current user - Yes / No / Cancelled

(required)

"FeedbackReceivedStatus":

VALUES SET,

# Y/N/C - is current user received feedback for this item ( Yes / No / Cancelled )

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackReceivedStatusText":

"STRING"

# printable feedback received for this item status - Yes / No / Cancelled

(required)

"AvailableOptions":

{

"Option":

[{

"ID":

INT,

# ASL option ID

(required)

"Code":

VALUES SET,

# ASL string code like (PayNowViaPPPay, RequestInvoiceFromSeller ...) , use this to make all checks in code.

(required)

"Text":

"STRING",

# Option title ( use to show on screen as choose option )

(required)

"ExtraParam":

"STRING",

# Some extra params for option , currently used only for question reply and include question ID .

(required)

"TextNeed":

VALUES SET

(required)

Y=user required enter text | N=text is not need | C=option cannot be submit

}]

(required)

# Available after sale actions

(required)

"Log":

{

"Message":

[{

"ID":

INT,

# ASL log entry ID

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# ASL log user ( who logged )

(required)

"UnixTime":

INT,

# Unix timestamp when entry added

(required)

"Time":

"STRING",

# Printable time when log entry added

(required)

"Type":

VALUES SET,

# A numeric value relating to the type of ASL entry.

(required)

"TextType":

"STRING",

# Log entry type ( printable text )

(required)

"Details":

"STRING",

# Log entry message ( entered by user or generated )

(required)

"ReplyTo":

INT,

# ReplyID to some other log entry ( only for questions replies )

(required)

"NudgeCount":

INT,

# Nudge count ( questions only )

(required)

"LastNudgeUnixTime":

INT,

# Unix Timestamp of last nudge ( questions only )

(required)

"LastNudge":

"STRING",

# Last nudge time ( printable format )

(required)

"FeedbackMessage":

"STRING"

# Feedback message ( only for feedbacks )

(required)

}]

(required)

# ASL Log entry

(required)

}],

(required)

"ReservePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing reserve price .

(required)

"AutoOfferAcceptPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers auto accept price

(required)

"AutoOfferDeclinePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers Auto decline price

(required)

"ToRepostCount":

INT,

# Count of autoreposts still due for this listing

(required)

"ToRepostOriginalCount":

INT,

# Initial value of count of listing autoreposts

(required)

"BuynowDiscount":

DECIMAL,

# Current buynow discount rate , is percent from 0 to 99.9

(required)

"ItemSpecificRaw":

"STRING",

# Item specific string , color , sizes , etc . Same format as for bulk upload .

(required)

"Duration":

{

"Days":

INT,

# Days

(required)

"Hours":

INT,

# Hours , available to Seller+ accounts only

(required)

"Mins":

INT,

# Mins , available for Seller+ accounts only

(required)

"UntilSold":

VALUES SET,

# Y/(empty value ) is this listing is Run Until Sold , if so then Days/Hours/Mins is empty

(required)

Y=Yes | =No (empty value)

"AutoExtend":

VALUES SET

# Y/N value , is listing auto extended when busy bids made.

(required)

Y=yes | N=No

# Original listing duration

(required)

"StartListing":

{

"Type":

VALUES SET

# Listing start options : "immediately" , "onfirstbid"

(required)

immediate=Immediate | onfirstbid=On firts bid | custom=Custom time

# Listing start information

(required)

"Tax":

[{

"State":

"STRING",

# Tax state code ( like NY, FL etc )

(required)

"Rate":

DECIMAL,

# Tax rate ( percent )

(required)

"ApplyToShipping":

VALUES SET

# Y/(empty value) - is tax applied to shipping also

(required)

Y=Yes | =No (empty value)

}],

(required)

"URL":

"STRING",

# Listing URL pointed to eBid listing page

(required)

"QuestionsCount":

INT,

# Questions count or empty value. Questions count provided only with options "QuestionsCount=Y" or "QuestionsHistory=Y"

(required)

"Questions":

{

"QuestionID":

INT,

# Question ID

(required)

"ListingID":

INT,

# Listing ID

(required)

"Poster":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Question poster ( user object )

(required)

"UnixTime":

INT,

# Unixtimestamp time when question/reply posted

(required)

"Time":

"STRING",

# Printable question/reply time

(required)

"Message":

"STRING",

# Question/Reply text

(required)

"ReplyToID":

INT,

# ID of question replied or empty if is not reply

(required)

"NudgeCount":

INT,

# Nudge count ( how many times user nudged question )

(required)

"LastNudgeUnixTime":

INT,

# Unix timestamp when question last nudged

(required)

"LastNudgeTime":

"STRING"

# Printable time when question last time nudged

(required)

# Is quertion history only if option "QuestionsHistory=Y"

(required)

"DispatchTime":

{

"Code":

VALUES SET,

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(required)

"Label":

"STRING"

# Dispatch time information ( text ) as shown on eBid Listing pages

(required)

# Item dispatch time information

(required)

"ReturnPolicy":

{

"Code":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(required)

"Label":

"STRING"

# Return policy text

(required)

# Return policy information

(required)

"CategoryPath":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# opted by option "FullCategoryPath=Y"

(required)

"CategoryPath2":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# Category path for second category , if category present and query opted with 'FullCategoryPath=Y'

(required)

"RepostedIDs":

"STRING",

# If listing is closed and in request option RepostedIDs=Y was set , then it return comma separated list of ids of listings reposted from this one . Most recently reposted is first in the list .

(optional)

"Variations":

{

"ImageTag":

"STRING",

# Variation image tag

(required)

[

"Variation":

{

"Image":

{

"ImageLarge":

"STRING",

# Big image URL

(required)

"ImageSmall":

"STRING",

# Small image URL

(required)

"ImageMedium":

"STRING",

# Medium image URL

(required)

"eBidImage":

VALUES SET

# Is image stored at eBid servers ? Y/N

(required)

Y=yes | N=No

# Image info

(optional)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Variation price

(required)

"Quantity":

INT,

# Items quantity

(required)

"QuantitySold":

INT,

# Quantity already Sold

(required)

"Barcode":

"STRING",

# UPC/EAN/MPN code

(required)

"ItemSpecifics":

{

"Name":

"STRING",

# Attribute name

(required)

"Value":

"STRING"

# Attribute value

(required)

# Variation specifics

(required)

]

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING",

# Variation Maximum Price (added in 2.0)

(required)

"ItemSpecifics":

[{

"Name":

"STRING",

# Tag name

(required)

"Value":

"STRING"

# Tag value

(required)

}]

(required)

}

(required)

}

GetPaymentOptionValues
Returns the possible payment options available to the user or eBid country site in question. eg. PayPal, Skrill, Checks, Postal Orders etc. Can be used to populate a form to list an item for sale.

GetShippingOptionValues
Returns all the shipping options available to an eBid country site both international and domestic. Can be used to populate forms for listing items on eBid.

API Command: GetShippingOptionValues
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetShippingOptionValues" ,

}

RESPONSE

{
"APIVersion": "",

"Option":

[{

"Code":

"STRING",

# eBid postage code , like '01' , '02' etc

(required)

"Name":

"STRING",

# Shipping option name like Royal Mail Airmail , Royal Mail Airsure, Royal Mail Surface Mail

(required)

"Calculated":

VALUES SET,

# Is this option is available for calculations ( retrieve price from third provider by package weight and type )

(required)

Y=yes | N=No

"Type":

VALUES SET,

# Shipping type = 'Domestic' or 'International'

(required)

Domestic=Domestic | International=International

"PriceNotNeed":

VALUES SET,

# Y/(empty value) - if options does not require price ( free shipping , unknown , now willing ship abroad )

(required)

Y=Yes | =No (empty value)

"Dimension":

[{

"SizeCode":

VALUES SET,

# eBid package type code - 'a' = Letter, 'b' = Large Envelope , 'c' = UPS Letter , 'd' = Regular Package , 'e' = Large Package , 'f' = Oversize Package , 'g' = Extra Large Package/Oversize 3

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"SizeName":

"STRING",

# Size name

(required)

"SizeRequired":

VALUES SET,

# Y/N value is dimensions required for this package size ( X,Y,Z )

(required)

Y=yes | N=No

"ExtraOptions":

VALUES SET

# Extra options for this package size , possible options : 'machinable' , 'container+girth' , 'fedex_pack' ( see on US eBid site posing form for these options , only for calculated options )

(required)

machinable=Machinable | container+girth=Container type | fedex_pack=Fedex package

}]

(required)

}],

(required)

"FedexPackage":

[{

"PackageType":

VALUES SET,

# eBid package type code - 'a' = Letter, 'b' = Large Envelope , 'c' = UPS Letter , 'd' = Regular Package , 'e' = Large Package , 'f' = Oversize Package , 'g' = Extra Large Package/Oversize 3

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"option":

{

"value":

VALUES SET,

# fedex package code , 'a' , 'b', 'c' , 'd' , 'e' , 'f' , 'g'

(required)

"text":

"STRING"

# Fedex package printable value ( FedEx 10kg Box , FedEx 25kg Box, FedEx Box, FedEx Envelope, FedEx Pak, FedEx Tube, Your Packaging )

(required)

}]

(required)

}

SaveListingClose
This method will close live listings, up to 10,000 at once. If there are less than 5 ListingIDs then the will be closed immediately, if more then they will be queued for a few minutes time.

SaveListingDelete
This API method will delete listings. Up to 10,000 can be deleted (not closed) immediately. Note : this will eradicate the listings and not close them into a users account history.

SaveListingEdit
Save changes to a live listing.

API Command: SaveListingEdit
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "SaveListingEdit" ,

"LoginKey":

"STRING",

# User Login Key

(optional)

"ListingID":

"STRING",

# Listing ID to edit

(required)

"Title":

"STRING",

# Listing title

(optional)

"Description":

"STRING",

# Listing description

(optional)

"StartBid":

DECIMAL,

# Listing starting price , only if bids not made yet.

(optional)

"BuyNowPrice":

DECIMAL,

# Buy Now price . If bids not made yet.

(optional)

"ReservePrice":

DECIMAL,

# Reserver price , can be updated if no bids already made.

(optional)

"CategoryID":

INT,

# Listing category ID

(optional)

"Barcode":

"STRING",

# Item EAN/UPC barcode , of special value 'exempt' if barcode not applicable for item ( unique , handmade , rarity )

(optional)

"Quantity":

INT,

# Quantity to sel , max 99 items

(optional)

"DispatchTime":

"STRING",

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(required)

"ReturnPolicy":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(optional)

"Store":

{

"StoreID":

INT,

# Store id where to list listing

(optional)

"StoreCategory":

"STRING"

# Store category id where list listing

(required)

(optional)

"AdultHide":

"STRING",

# Y/N value . If listing is adult , need hide bidder usernames.

(optional)

"Duration":

{

"Days":

"STRING",

# Days

(required)

"Hours":

"STRING",

# Hours

(optional)

"Mins":

INT,

# Mins

(optional)

"AutoExtend":

"STRING",

# Y/N value . is listing autoextented when busy bids made near listing end

(optional)

"UntilSold":

"STRING"

# Y/N value . Sell till sold . Days / hours then not need and StartListing Type tag must me 'immediatelly'

(optional)

# Listing duration

(optional)

"Duration":

INT,

# Alternative duration define , just as days

(optional)

"RepostCount":

INT,

# Number of auto reposts for this listing . 0-10 times.

(optional)

"Movie":

"STRING",

# URL to video . 11 character YouTube id number for your movie .

(optional)

"SKU":

"STRING",

# Your SKU ( any value up to 100 chars )

(optional)

"AcceptOffers":

"STRING",

# Y/N value , if seller accept offers for this listing

(optional)

"AutoOfferAcceptPrice":

DECIMAL,

# Auto accept offers price if seller accept offers .

(optional)

"AutoOfferDeclinePrice":

"STRING",

# Auto decline price if seller accept offers .

(optional)

"Feature":

"STRING",

# Listing feature : 'none' , 'special', 'gallery', 'platinum', 'standard' , 'front'

(optional)

"Extras":

{

"Bold":

"STRING",

# Y/N value . Feature listing listing as bold .

(optional)

"Highlight":

"STRING",

# Y/N value . Highlight listing in results .

(optional)

"Images":

{

"Image":

["STRING"]

# URL to image . These images extra charged.

(required)

"CategoryID":

INT,

# Second category ID for listing .

(optional)

"SubTitle":

"STRING"

# Listing subtitle

(optional)

# Extra payable listing features

(optional)

"DomesticShippings":

{

"Type":

"STRING",

# possible values 'flat' ( fixed rates ) or 'calculated'( calculate by weight for some countries/services )

(required)

"DomesticShipping":

[{

"Price":

DECIMAL,

# Shipping price

(required)

"ShippingService":

"STRING",

# Shipping service eBid code , see query GetShippingOptionsValues , to retrieve all codes .

(required)

"ExtraItemPrice":

DECIMAL

# Price for 2nd item in the package , for multi item listings only and if price is different then 1nd item .

(required)

}],

# Flat domestic type input

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

INT,

(required)

"Y":

INT,

(required)

"Z":

INT

(required)

# Package sizes , not required for some postage methods

(optional)

"Weight":

{

"Lbs":

INT,

# Lbs or kg

(required)

"Oz":

INT

# Oz or gramms depend from site

(required)

# Package weight , in current sire weight units ( lb + oz , or kg + gramms )

(required)

"ExtraWeight":

{

"Lbs":

INT,

# Lbs or kg depend from site

(required)

"Oz":

INT

# Oz or gramms depend from site

(required)

# Weight for 2nd and next items for multi item listings and if weight different then 1st item .

(optional)

"PackageSize":

VALUES SET,

# eBid package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

[

"Option":

{

"ShippingService":

"STRING",

# Shipping service code , see query GetShippingOptionsValues to get all options

(required)

"Machinable":

VALUES SET,

# Y/N value , is package machinable ( required for some postage methods )

(optional)

Y=yes | N=No

"Rectangular":

VALUES SET,

# Y/N value is package rectangular . If so , then need set also Girth field.

(optional)

Y=yes | N=No

"Girth":

INT,

# Girth

(optional)

"FedexPackage":

VALUES SET

# fedex package eBid code

(required)

}

(required)

]

(optional)

"InternationalShippings":

{

"Type":

"STRING",

# 'flat' or 'calculated' , depend from type need read other fields. Calculated is for some services that can be calculated by weight .

(required)

"InternationalShipping":

[{

"Price":

DECIMAL,

# Shipping price

(required)

"ShippingService":

"STRING",

# eBid shipping service code . to see all codes - query : GetShippingOptionsValues

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list codes , like "uk,us,eu"

(required)

"ExtraItemPrice":

DECIMAL

# Price for shipping 2nd and next item for multi item listings and if shipping price is different then for 1nd item

(required)

}],

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

INT,

(required)

"Y":

INT,

(required)

"Z":

INT

(required)

# Package dimenstions . in inch or in cm depend from site measure units

(required)

"Weight":

{

"Lbs":

"STRING",

# Lbs or Kg depend from weight units

(required)

"Oz":

"STRING"

# Oz or gramms

(required)

# Package weight ( lbs + oz , or kg + gramms ) depend from site weight unit .

(required)

"ExtraWeight":

{

"Lbs":

INT,

# Lbs or kg depend from site weight units

(required)

"Oz":

INT

# Oz or gramms depend from site measure units

(required)

# Shipping weight for 2nd and next item in the package , only for multi item listings and if 2nd package weight is different from 1st .

(optional)

"PackageSize":

VALUES SET,

# eBid package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

[

"InternationalShipping":

{

"ShippingService":

"STRING",

# Shipping service code , to see all query : GetShippingOptionsValues

(required)

"AvailableTo":

VALUES SET,

# Comma separated country list to which shipping available like "uk,us,eu"

(required)

"Machinable":

VALUES SET,

# Y/N value , is package machinable , required for some shippings services only

(optional)

Y=yes | N=No

"Rectangular":

VALUES SET,

# Y/N value , is package rectangular , if so , then need specify also Girth

(optional)

Y=yes | N=No

"FedexPackage":

VALUES SET

# eBid Fedex package code ( fedex packages only )

(optional)

}

(required)

]

# International shippings

(optional)

"PaymentMethod":

"STRING",

# Comma separated payment methods codes . to retrieve all see query : GetPaymentOptionsValues .

(optional)

"ItemCondition":

"STRING",

# Item conditional , possible values : 'New','Used','Unused','Refurbished'

(optional)

"Brand":

"STRING",

# Item brand like 'microsoft' , 'dell'

(optional)

"Tax":

{

"State":

"STRING",

# State code like NY, FL etc

(required)

"Rate":

"STRING",

# Tax rate 0 - 99.9 percents.

(required)

"ApplyToShipping":

"STRING"

# Y/N value - is tax applied also to shippings .

(required)

# Tax information ( only for countries that support tax calculations or error will return )

(optional)

"BuynowDiscount":

DECIMAL,

# Buynow discount percent .

(optional)

"BuynowDiscountLength":

INT,

# Buy now dicount length , depend from BuynowDiscountType field is hours or days

(optional)

"BuynowDiscountType":

"STRING",

# 'hrs' or 'days' - buynow discount length

(optional)

"PostageCode":

"STRING",

# Postage Shipping Code

(optional)

"StartListing":

{

"Type":

"STRING",

# Possible values : 'custom', 'onfirstbid' , 'immediately' . Custom require to set start time .Onfirst bid and immediatelly listings use duration from Duration field.

(required)

"Date":

"STRING"

# date when listing start , only for 'Custom' . Format is YYYY-MM-DD hh:mm:ss .

(required)

# Listing start time

(optional)

"Images":

{

"MainImage":

"STRING",

(required)

"Image":

["STRING"]

# URL to image . can be multiple images following eBid rules.

(optional)

"ItemSpecificRaw":

"STRING",

# Item spcific attributes in eBid format ( color , sizes , etc )

(optional)

"Variations": # (added in 2.0)

{

[

"Variation":

{

"Image":

["STRING"],

# Variation Image

(optional)

"Price":

DECIMAL,

# Variation Price

(required)

"Barcode":

"STRING",

# ISBN/UPC/EAN/MPN code

(optional)

"Quantity":

INT,

# Variation Quantity

(required)

[

"ItemSpecifics":

{

"Name":

"STRING",

# Specifics Tag name

(required)

"Value":

"STRING"

# Specifics value

(required)

# Variation Specifics

(required)

]

(required)

]

# (added in 2.0)

(optional)

[

"ItemSpecifics": # (added in 2.0)

{

"Name":

"STRING",

# Specifics tag name

(required)

"Value":

"STRING"

# Specifics Value

(required)

# (added in 2.0)

(optional)

]

}

RESPONSE

{
"APIVersion": "",

"Listing":

{

"ListingID":

INT,

# Listing ID

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Listing Seller data

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Listing category

(required)

"Category2":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Second category , if present or empty tag is not

(optional)

"Title":

"STRING",

# Listing title

(required)

"SubTitle":

"STRING",

# Listing subtitle ( if present )

(required)

"Bold":

VALUES SET,

# Y/N value , is listing bold

(required)

Y=yes | N=No

"Highlight":

VALUES SET,

# Y/N value , is listing highlighten in listings

(required)

Y=yes | N=No

"Movie":

"STRING",

# Listing movie ID

(required)

"Brand":

"STRING",

# Listing brand

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image large version ( or empty )

(required)

"PrimaryImageSmall":

"STRING",

# URL to Listing primary image small version or empty

(required)

"PrimaryImageMedium":

"STRING",

# URL to Listing primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N - Is image uploaded to eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N , is image is part of UPC/EAN library

(required)

"Quantity":

INT,

# Listing quantity ( 1 - max value )

(required)

"StartTime":

"STRING",

# Listing start time printable version

(required)

"StartTimeUnix":

INT,

# Start time , Unixtimestamp

(required)

"StartPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing Start price value

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"NextBid":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Next prossible bid or empty if not applicable

(required)

"Increment":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Increment value

(required)

"BidCount":

INT,

# Count of bids already made

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"BuyNowAvailable":

INT,

# Items quantity available for BuyNow

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price for this Listing

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price exchanged to local currency ( current country view )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price exchanged to current country currency

(required)

"Views":

INT,

# Listing views count ( how many it was viewed on eBid )

(required)

"Description":

"STRING",

# Listing Description

(required)

"Store":

{

"StoreID":

INT,

# Store ID

(required)

"Owner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Store owner

(required)

"Title":

"STRING",

# Store title ( name )

(required)

"Description":

"STRING",

# Store description

(required)

"Category":

INT,

# Store classification category ID ( ebid categories )

(required)

"Image":

"STRING",

# URL of store banner image

(required)

"ListingsCount":

INT,

# Count of listings in this store

(required)

"Link":

"STRING",

# URL to store ( link to eBid )

(required)

"Online":

VALUES SET

# Y/N value is store online

(required)

Y=yes | N=No

# Listing Store

(required)

"StoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Store category where listing listed ( or empty if not in store )

(required)

"ParentStoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Parent Store category where it listed or empty value

(required)

"AutoExtended":

VALUES SET,

# Y/N value , is autoextend set for Listing

(required)

Y=yes | N=No

"Barcode":

"STRING",

# UPC/EAN barcode code or empty value , or special value "EXEMPT"

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"ItemCondition":

{

"ID":

VALUES SET,

# Item condition id , n - new , u - used , s - unused , r - refurbished , '' - any

(required)

n=New | u=Used | s=Unused | r=Refurbished | =Any

"Name":

"STRING",

# Printable name of option

(required)

"APIName":

"STRING"

# API name to refer for API ( NEW , USED, UNUSED, REFURBISHED, ANY )

(required)

# Listing item condition

(required)

"PaymentOptions":

{

"PaymentOption":

[{

"ID":

INT,

# Option ID

(required)

"Name":

"STRING"

# Option name

(required)

}]

(required)

# Payment options available for listing

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"ShipTo":

VALUES SET,

# ISO country code for which current shipping price calculated

(required)

"ShipToName":

"STRING",

# Country name to which current shipping prices calculated

(required)

"ShipToZip":

"STRING",

# zip/postcode to which current shipping price calculated ( if required or present ).

(required)

"Shippings":

{

"DomesticShippings":

{

"Type":

"STRING",

# constant - "calculated"

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions (cm , or inch)

(required)

"Weight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Package weight ( for some countries is kg and gramms )

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

"STRING",

# Package girth ( inch )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Fedex package options or empty values

(optional)

}],

(required)

"PackageName":

"STRING"

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"DomesticShippings":

{

"Type":

"STRING",

# "flat" - is hardcoded , can be used to indefiny shipping type

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL

# Extra item shipping price ( if different then 1st item shipping price and if multi item listing )

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# shipping object type , hardcoded value "calculated"

(required)

"Handling":

DECIMAL,

# handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions ( in cm or inch depend from country )

(required)

"Weight":

{

"Lbs":

"STRING",

(required)

"Oz":

"STRING"

(required)

# Package weigh lb & oz or kg and gramms depend from country

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"PackageName":

"STRING",

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

DECIMAL,

# Package girth ( if applicable )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Options filled only if package is fedex

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# postage type , hardcoded value "flat"

(required)

"Option":

[{

"ShippingService":

"STRING",

# Postage service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL,

# Extra item shipping price ( if quantity more then 1 and shipping price is different then 1st item )

(required)

"AvailableTo":

VALUES SET

# Comma separated ISO country lists to which this shipping possible ( like "uk,us,de" )

(required)

}]

(required)

"Shipping":

{

"Code":

"STRING",

# Shipping method eBid code

(required)

"Name":

"STRING",

# Shipping method postage name ( like Royal Mail 1st Class , Parcelforce (2 Day Delivery) , etc )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"PriceExchanged":

"STRING",

# Shipping price exchanged to current site currency

(required)

"Calculated":

"STRING",

# Y/N - is price received from postage service provider ( N - defined directly by user )

(required)

"ShippingTo":

"STRING",

# ISO Country code for this shipping price ( like uk , us, etc )

(required)

"ShippingToName":

"STRING",

# Country Name for this shipping price ( like United States , Canada , etc )

(required)

"ExtraDetails":

"STRING"

# Extar details for this postage method ( Not available or to be calculated ) , can replace price by this text

(required)

}

(required)

# Listing shipping data . Depend from parameters and listing shipping data this tag may include different optional shipping parameters.

(required)

"MinShippingCost":

"STRING",

# Minimal shipping cost for this listing to choosed or default country

(required)

"MinShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"MinShippingCostName":

"STRING",

# Minimal shipping cost postage method ( printable label like "Royal Mail Airmail" ...)

(required)

"UserListingsCount":

INT,

# Listings count for this listing , is optional depend from parameters.

(optional)

"ShipZipRequiredDom":

VALUES SET,

# Y/(empty value) , is zip postacode required to calculate Domestic shipping prices

(required)

Y=Yes | =No (empty value)

"ShipZipRequiredInt":

VALUES SET,

# Y/(empty value) is zip/postcode required to calculate international price

(required)

Y=Yes | =No (empty value)

"Bids":

{

"Bid":

[{

"BidID":

INT,

# Bid ID

(required)

"BuyNow":

VALUES SET,

# Y/(empty value) - is this buynow bid record

(required)

Y=Yes | =No (empty value)

"UserID":

INT,

# Bidder UserID ( possible 0 - when name hidden , adult listings)

(required)

"Username":

"STRING",

# Bidder username

(required)

"UnixTime":

"STRING",

# Unix Timestamp when bid made

(required)

"Amount":

"STRING",

# Bid amount , possible value "Not Public" for non public values

(required)

"Allocation":

INT,

# Quandtity allocated by this bid ( for dutch listings possible less then quantity )

(required)

"Quantity":

INT,

# Bid quantity

(required)

"QuantityText":

"STRING",

# Printable bid quantity , use to output

(required)

"Time":

"STRING",

# Printable bid time

(required)

"MAO":

VALUES SET,

# Y/(empty value) - is bid generated by successful offer

(required)

Y=Yes | =No (empty value)

"IconType":

VALUES SET,

# Bid icon type - p, r, b ( proxy , reserve meet , buynow )

(required)

p=Proxy | r=Reserve meet | b=Buynow

"IconImages":

"STRING",

# Icon images tags , include IMG tage , possible few together.

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Bidder user object , may not be here if private listing , or can be full version if some params present.

(optional)

"HiddenName":

VALUES SET,

# Y/(empty value) - is name hidden

(required)

Y=Yes | =No (empty value)

"NotPublic":

VALUES SET,

# Y/(empty value) - is amount public or no

(required)

Y=Yes | =No (empty value)

"BuyerFullInfo":

VALUES SET

# Y/(empty value) - is User tag include full version of user object

(required)

Y=Yes | =No (empty value)

}]

(required)

# Bids history for this listing , only if it required in initial query , or empty value

(required)

"Type":

VALUES SET,

# "n" or "d" char , Listing type n-single item listing , d - multi item listing

(required)

n=Single item listing | d=Multi item listing

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing/listing price

(required)

"AdultHiddenName":

[{

"UserID":

INT,

# UserID

(required)

"Username":

"STRING"

# Hidden name replacement like "hiddenname1"

(required)

}],

(required)

"AdultHide":

"STRING",

# Y/N value - is listing opted as Adult Hide Usernames

(required)

"ItemsAvailableBid":

INT,

# Quantity available to bid . If holiday notice set - bidding is not available .

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empy value) - is bidding available for this listing now . Do not show bid form if this field is not set to Y.

(required)

Y=Yes | =No (empty value)

"HolidayNotice":

VALUES SET,

# Y/N value . Is User notice is holiday ( user is on vacancy , and bidding not available )

(required)

Y=yes | N=No

"HolidayNoticeText":

"STRING",

# Holiday notice text , If notify is present then user text or empty.

(required)

"Watch":

VALUES SET,

# Y/N value , is current user watching this listing , only if login info sent with request .

(required)

Y=yes | N=No

"ListingStateSuccess":

VALUES SET,

# Y/N value , is this listing for current user is success ( high bidder , buyed via buynow ) , empty value if user login info not sent with query

(required)

Y=yes | N=No

"ListingStateMessage":

"STRING",

# Listing status message normally shown on eBid listing page at top , only for logged in users ( if login info sent with query )

(required)

"ListingQuestionState":

"STRING",

# Listing question state , only if login data sent with this query e.q. for logged info only . Or empty.

(required)

"Live":

VALUES SET,

# Y/(empty value) - is listing live , e.q. running . listing is live while it not moved to myeBid closed area ( not just time expired ).

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/N value - Is seller accept offers for this listing .

(required)

Y=yes | N=No

"OffersStatus":

"STRING",

# Offers status normally shown at top of eBid listing page , is not empty if seller accept offers , some offer made , and user logged in ( logged info sent with query )

(required)

"OffersAttentionRequired":

VALUES SET,

# Y/N value , is current offers required logged user attention . For example seller attention required when offers made . Is set only if logged user info provided with query.

(required)

Y=yes | N=No

"OffersHistoryCount":

INT,

# How many offers made for this listing/listing

(required)

"PrimaryMarket":

VALUES SET,

# Primary market ISO country code like "us" , "uk" , "eu" ...

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list like "us,uk,eu" or similar . Listing is available on these eBid markets .

(required)

"ASL":

[{

"Sale":

{

"SaleID":

INT,

# Sale ID

(required)

"Buyer":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Buyer info

(required)

"UnixTime":

INT,

# Unix Timestamp when sale made

(required)

"Time":

"STRING",

# Printable when sale made

(required)

"PurchasePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price

(required)

"PurchasePriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price exchanged to current country currency

(required)

"Quantity":

INT,

# Quantity of items purchased

(required)

"ShippingPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"ShippingPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price exchanged to current country currency

(required)

"TotalAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Total sale amount

(required)

"TotalAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total Amount exchanged to current country currency

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

}

# Items Seller object

(required)

"Status":

{

"InvoiceStatus":

VALUES SET,

# Y/N value is invoice sent

(required)

Y=yes | N=No

"InvoiceStatusText":

"STRING",

# is invoice sent - Yes/No text status

(required)

"PaymentStatus":

VALUES SET,

# C/R/NP/Y/YN/N values where C - Cancelled, R - Refunded, NP - Non Payed , Y - Payed, YN - Pending , N - Not Yet

(required)

"PaymentStatusText":

"STRING",

# Payment status printable text - Cancelled / Refunded / Non Payed / Payed / Pending / Not Yet

(required)

"ShipmentStatus":

VALUES SET,

# Y/N/C - is item shipped - yes , no , cancelled

(required)

Y=Shipped | N=Not Shipped | C=Cancelled

"ShipmentStatusText":

"STRING",

# text value for shipment status - Yes / No / Cancelled

(required)

"FeedbackLeftStatus":

VALUES SET,

# Is feedback left by current user - Y/N/C - Yes, No , Cancelled

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackLeftStatusText":

"STRING",

# Is feedback leaved by current user - Yes / No / Cancelled

(required)

"FeedbackReceivedStatus":

VALUES SET,

# Y/N/C - is current user received feedback for this item ( Yes / No / Cancelled )

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackReceivedStatusText":

"STRING"

# printable feedback received for this item status - Yes / No / Cancelled

(required)

"AvailableOptions":

{

"Option":

[{

"ID":

INT,

# ASL option ID

(required)

"Code":

VALUES SET,

# ASL string code like (PayNowViaPPPay, RequestInvoiceFromSeller ...) , use this to make all checks in code.

(required)

"Text":

"STRING",

# Option title ( use to show on screen as choose option )

(required)

"ExtraParam":

"STRING",

# Some extra params for option , currently used only for question reply and include question ID .

(required)

"TextNeed":

VALUES SET

(required)

Y=user required enter text | N=text is not need | C=option cannot be submit

}]

(required)

# Available after sale actions

(required)

"Log":

{

"Message":

[{

"ID":

INT,

# ASL log entry ID

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# ASL log user ( who logged )

(required)

"UnixTime":

INT,

# Unix timestamp when entry added

(required)

"Time":

"STRING",

# Printable time when log entry added

(required)

"Type":

VALUES SET,

# A numeric value relating to the type of ASL entry.

(required)

"TextType":

"STRING",

# Log entry type ( printable text )

(required)

"Details":

"STRING",

# Log entry message ( entered by user or generated )

(required)

"ReplyTo":

INT,

# ReplyID to some other log entry ( only for questions replies )

(required)

"NudgeCount":

INT,

# Nudge count ( questions only )

(required)

"LastNudgeUnixTime":

INT,

# Unix Timestamp of last nudge ( questions only )

(required)

"LastNudge":

"STRING",

# Last nudge time ( printable format )

(required)

"FeedbackMessage":

"STRING"

# Feedback message ( only for feedbacks )

(required)

}]

(required)

# ASL Log entry

(required)

}],

(required)

"ReservePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing reserve price .

(required)

"AutoOfferAcceptPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers auto accept price

(required)

"AutoOfferDeclinePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers Auto decline price

(required)

"ToRepostCount":

INT,

# Count of autoreposts still due for this listing

(required)

"ToRepostOriginalCount":

INT,

# Initial value of count of listing autoreposts

(required)

"BuynowDiscount":

DECIMAL,

# Current buynow discount rate , is percent from 0 to 99.9

(required)

"ItemSpecificRaw":

"STRING",

# Item specific string , color , sizes , etc . Same format as for bulk upload .

(required)

"Duration":

{

"Days":

INT,

# Days

(required)

"Hours":

INT,

# Hours , available to Seller+ accounts only

(required)

"Mins":

INT,

# Mins , available for Seller+ accounts only

(required)

"UntilSold":

VALUES SET,

# Y/(empty value ) is this listing is Run Until Sold , if so then Days/Hours/Mins is empty

(required)

Y=Yes | =No (empty value)

"AutoExtend":

VALUES SET

# Y/N value , is listing auto extended when busy bids made.

(required)

Y=yes | N=No

# Original listing duration

(required)

"StartListing":

{

"Type":

VALUES SET

# Listing start options : "immediately" , "onfirstbid"

(required)

immediate=Immediate | onfirstbid=On firts bid | custom=Custom time

# Listing start information

(required)

"Tax":

[{

"State":

"STRING",

# Tax state code ( like NY, FL etc )

(required)

"Rate":

DECIMAL,

# Tax rate ( percent )

(required)

"ApplyToShipping":

VALUES SET

# Y/(empty value) - is tax applied to shipping also

(required)

Y=Yes | =No (empty value)

}],

(required)

"URL":

"STRING",

# Listing URL pointed to eBid listing page

(required)

"QuestionsCount":

INT,

# Questions count or empty value. Questions count provided only with options "QuestionsCount=Y" or "QuestionsHistory=Y"

(required)

"Questions":

{

"QuestionID":

INT,

# Question ID

(required)

"ListingID":

INT,

# Listing ID

(required)

"Poster":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Question poster ( user object )

(required)

"UnixTime":

INT,

# Unixtimestamp time when question/reply posted

(required)

"Time":

"STRING",

# Printable question/reply time

(required)

"Message":

"STRING",

# Question/Reply text

(required)

"ReplyToID":

INT,

# ID of question replied or empty if is not reply

(required)

"NudgeCount":

INT,

# Nudge count ( how many times user nudged question )

(required)

"LastNudgeUnixTime":

INT,

# Unix timestamp when question last nudged

(required)

"LastNudgeTime":

"STRING"

# Printable time when question last time nudged

(required)

# Is quertion history only if option "QuestionsHistory=Y"

(required)

"DispatchTime":

{

"Code":

VALUES SET,

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(required)

"Label":

"STRING"

# Dispatch time information ( text ) as shown on eBid Listing pages

(required)

# Item dispatch time information

(required)

"ReturnPolicy":

{

"Code":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(required)

"Label":

"STRING"

# Return policy text

(required)

# Return policy information

(required)

"CategoryPath":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# opted by option "FullCategoryPath=Y"

(required)

"CategoryPath2":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# Category path for second category , if category present and query opted with 'FullCategoryPath=Y'

(required)

"RepostedIDs":

"STRING",

# If listing is closed and in request option RepostedIDs=Y was set , then it return comma separated list of ids of listings reposted from this one . Most recently reposted is first in the list .

(optional)

"Variations":

{

"ImageTag":

"STRING",

# Variation image tag

(required)

[

"Variation":

{

"Image":

{

"ImageLarge":

"STRING",

# Big image URL

(required)

"ImageSmall":

"STRING",

# Small image URL

(required)

"ImageMedium":

"STRING",

# Medium image URL

(required)

"eBidImage":

VALUES SET

# Is image stored at eBid servers ? Y/N

(required)

Y=yes | N=No

# Image info

(optional)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Variation price

(required)

"Quantity":

INT,

# Items quantity

(required)

"QuantitySold":

INT,

# Quantity already Sold

(required)

"Barcode":

"STRING",

# UPC/EAN/MPN code

(required)

"ItemSpecifics":

{

"Name":

"STRING",

# Attribute name

(required)

"Value":

"STRING"

# Attribute value

(required)

# Variation specifics

(required)

]

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING",

# Variation Maximum Price (added in 2.0)

(required)

"ItemSpecifics":

[{

"Name":

"STRING",

# Tag name

(required)

"Value":

"STRING"

# Tag value

(required)

}]

(required)

}

(required)

}

SaveListingNew
Post an item for sale on eBid. Will return the listing ID of the new item if successful.

API Command: SaveListingNew
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "SaveListingNew" ,

"LoginKey":

"STRING",

# User login key

(required)

"CategoryID":

INT,

# Categry ID

(required)

"Title":

"STRING",

# Listing title

(required)

"Description":

"STRING",

# Listing description

(required)

"Quantity":

INT,

# Quantity to sel , max 99 items

(required)

"Duration":

{

"Days":

INT,

# Days

(required)

"Hours":

INT,

# Hours

(optional)

"Mins":

INT,

# Mins

(optional)

"AutoExtend":

VALUES SET,

# Y/N value . is listing autoextented when busy bids made near listing end

(optional)

Y=yes | N=No

"UntilSold":

VALUES SET

# Y/N value . Sell till sold . Days / hours then not need and StartListing Type tag must me 'immediatelly'

(optional)

Y=yes | N=No

# Listing duration

(optional)

"Duration":

INT,

# Is other way to specify duration - just days

(optional)

"StartBid":

DECIMAL,

# Starting price

(optional)

"ReservePrice":

DECIMAL,

# Reserve price . Multi-item listings does not have reserve price.

(optional)

"Feature":

VALUES SET,

# Listing feature : 'none' , 'special', 'gallery', 'platinum', 'standard' , 'front'

(optional)

"BuyNowPrice":

DECIMAL,

# Listing BuyNow price

(optional)

"Brand":

"STRING",

# Item brand like 'microsoft' , 'dell'

(optional)

"Store":

{

"StoreID":

INT,

# Store id where to list listing

(required)

"StoreCategory":

INT

# Store category id where list listing

(required)

(optional)

"AdultHide":

VALUES SET,

# Y/N value . If listing is adult , need hide bidder usernames.

(optional)

Y=yes | N=No

"ItemCondition":

VALUES SET,

# Item conditional , possible values : 'New','Used','Unused','Refurbished'

(optional)

n=New | u=Used | s=Unused | r=Refurbished | =Any

"Images":

{

"MainImage":

"STRING",

# URL to primary (thumbnail) image. This can be an eBid hosted image or alternatively an image from anywhere on the internet which we will then place into a queue for downloading to the eBid servers.

(required)

"Image":

["STRING"]

(optional)

"Extras":

{

"Bold":

VALUES SET,

# Y/N value . Feature listing listing as bold .

(optional)

Y=yes | N=No

"Highlight":

VALUES SET,

# Y/N value . Highlight listing in results .

(optional)

Y=yes | N=No

"Images":

{

"Image":

["STRING"]

# URL to image . These images extra charged.

(required)

(optional)

"CategoryID":

"STRING",

# Second category ID for listing .

(optional)

"SubTitle":

"STRING"

# Listing subtitle

(optional)

# Listing extra features , similar to section four of ebid listing start form .

(optional)

"Movie":

"STRING",

# URL to video . 11 character YouTube id number for your movie .

(optional)

"SKU":

"STRING",

# Your SKU ( any value up to 100 chars )

(optional)

"NoReserve":

VALUES SET,

# Y/(empty value ) - listing have no reserve price . Alternative - just do not specify ReservePrice field

(optional)

Y=yes | N=No

"RepostCount":

INT,

# Number of auto reposts for this listing . 0-10 times.

(optional)

"StartListing":

{

"Type":

VALUES SET,

# Possible values : 'custom', 'onfirstbid' , 'immediate' . Custom require to set start time .Onfirst bid and immediatelly listings use duration from Duration field.

(required)

immediate=Immediate | onfirstbid=On firts bid | custom=Custom time

"Date":

"STRING"

# date when listing start , only for 'Custom' . Format is YYYY-MM-DD hh:mm:ss .

(required)

# Listing start time

(optional)

"Tax":

{

"State":

"STRING",

# State code like NY, FL etc

(required)

"Rate":

DECIMAL,

# Tax rate 0 - 99.9 percents.

(required)

"ApplyToShipping":

VALUES SET

# Y/N value - is tax applied also to shippings .

(required)

Y=yes | N=No

# Tax information ( only for countries that support tax calculations or error will return )

(optional)

"PaymentMethod":

"STRING",

# Comma separated payment methods codes . to retrieve all see query : GetPaymentOptionsValues .

(required)

"DomesticShippings":

{

"Type":

"STRING",

# possible values 'flat' ( fixed rates ) or 'calculated'( calculate by weight for some countries/services )

(required)

"DomesticShipping":

[{

"Price":

DECIMAL,

# Shipping price

(required)

"ShippingService":

"STRING",

# Shipping service eBid code , see query GetShippingOptionsValues , to retrieve all codes .

(required)

"ExtraItemPrice":

DECIMAL

# Price for 2nd item in the package , for multi item listings only and if price is different then 1nd item .

(required)

}],

# Flat domestic type input

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

INT,

(required)

"Y":

INT,

(required)

"Z":

INT

(required)

# Package sizes , not required for some postage methods

(optional)

"Weight":

{

"Lbs":

INT,

# Lbs or kg

(required)

"Oz":

INT

# Oz or gramms depend from site

(required)

# Package weight , in current sire weight units ( lb + oz , or kg + gramms )

(required)

"ExtraWeight":

{

"Lbs":

INT,

# Lbs or kg depend from site

(required)

"Oz":

INT

# Oz or gramms depend from site

(required)

# Weight for 2nd and next items for multi item listings and if weight different then 1st item .

(optional)

"PackageSize":

VALUES SET,

# eBid package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

[

"Option":

{

"ShippingService":

"STRING",

# Shipping service code , see query GetShippingOptionsValues to get all options

(required)

"Machinable":

VALUES SET,

# Y/N value , is package machinable ( required for some postage methods )

(optional)

Y=yes | N=No

"Rectangular":

VALUES SET,

# Y/N value is package rectangular . If so , then need set also Girth field.

(optional)

Y=yes | N=No

"Girth":

INT,

# Girth

(optional)

"FedexPackage":

VALUES SET

# fedex package eBid code

(required)

}

(required)

]

# Domestic shipping

(required)

"InternationalShippings":

{

"Type":

"STRING",

# 'flat' or 'calculated' , depend from type need read other fields. Calculated is for some services that can be calculated by weight .

(required)

"InternationalShipping":

[{

"Price":

DECIMAL,

# Shipping price

(required)

"ShippingService":

"STRING",

# eBid shipping service code . to see all codes - query : GetShippingOptionsValues

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list codes , like "uk,us,eu"

(required)

"ExtraItemPrice":

DECIMAL

# Price for shipping 2nd and next item for multi item listings and if shipping price is different then for 1nd item

(required)

}],

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

INT,

(required)

"Y":

INT,

(required)

"Z":

INT

(required)

# Package dimenstions . in inch or in cm depend from site measure units

(required)

"Weight":

{

"Lbs":

"STRING",

# Lbs or Kg depend from weight units

(required)

"Oz":

"STRING"

# Oz or gramms

(required)

# Package weight ( lbs + oz , or kg + gramms ) depend from site weight unit .

(required)

"ExtraWeight":

{

"Lbs":

INT,

# Lbs or kg depend from site weight units

(required)

"Oz":

INT

# Oz or gramms depend from site measure units

(required)

# Shipping weight for 2nd and next item in the package , only for multi item listings and if 2nd package weight is different from 1st .

(optional)

"PackageSize":

VALUES SET,

# eBid package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

[

"InternationalShipping":

{

"ShippingService":

"STRING",

# Shipping service code , to see all query : GetShippingOptionsValues

(required)

"AvailableTo":

VALUES SET,

# Comma separated country list to which shipping available like "uk,us,eu"

(required)

"Machinable":

VALUES SET,

# Y/N value , is package machinable , required for some shippings services only

(optional)

Y=yes | N=No

"Rectangular":

VALUES SET,

# Y/N value , is package rectangular , if so , then need specify also Girth

(optional)

Y=yes | N=No

"FedexPackage":

VALUES SET

# eBid Fedex package code ( fedex packages only )

(optional)

}

(required)

]

(optional)

"AcceptOffers":

VALUES SET,

# Y/N value , if seller accept offers for this listing

(optional)

Y=yes | N=No

"AutoOfferAcceptPrice":

DECIMAL,

# Auto accept offers price if seller accept offers .

(optional)

"AutoOfferDeclinePrice":

DECIMAL,

# Auto decline price if seller accept offers .

(optional)

"Barcode":

"STRING",

# Item EAN/UPC barcode , of special value 'exempt' if barcode not applicable for item ( unique , handmade , rarity )

(optional)

"ItemSpecificRaw":

"STRING",

# Item spcific attributes in eBid format ( color , sizes , etc )

(optional)

"DispatchTime":

VALUES SET,

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(optional)

"ReturnPolicy":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(optional)

"RepostListingID":

INT,

# If this listing is repost copy of some closed listing this field include original listing ID.

(optional)

"Currency":

"STRING",

# Currency code like USD , EUR

(optional)

[

"ItemSpecifics": # (added in 2.0)

{

"Name":

"STRING",

# Specifics tag name

(required)

"Value":

"STRING"

# Specifics Value

(required)

# (added in 2.0)

(optional)

]

"Variations": # (added in 2.0)

{

[

"Variation":

{

"Image":

["STRING"],

# Variation Image

(optional)

"Price":

DECIMAL,

# Variation Price

(required)

"Barcode":

"STRING",

# ISBN/UPC/EAN/MPN code

(optional)

"Quantity":

INT,

# Variation Quantity

(required)

[

"ItemSpecifics":

{

"Name":

"STRING",

# Specifics Tag name

(required)

"Value":

"STRING"

# Specifics value

(required)

# Variation Specifics

(required)

]

# Variation Data

(required)

]

}

# (added in 2.0)

(optional)

}

RESPONSE

{
"APIVersion": "",

"Listing":

{

"ListingID":

INT,

# Listing ID

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Listing Seller data

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Listing category

(required)

"Category2":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Second category , if present or empty tag is not

(optional)

"Title":

"STRING",

# Listing title

(required)

"SubTitle":

"STRING",

# Listing subtitle ( if present )

(required)

"Bold":

VALUES SET,

# Y/N value , is listing bold

(required)

Y=yes | N=No

"Highlight":

VALUES SET,

# Y/N value , is listing highlighten in listings

(required)

Y=yes | N=No

"Movie":

"STRING",

# Listing movie ID

(required)

"Brand":

"STRING",

# Listing brand

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image large version ( or empty )

(required)

"PrimaryImageSmall":

"STRING",

# URL to Listing primary image small version or empty

(required)

"PrimaryImageMedium":

"STRING",

# URL to Listing primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N - Is image uploaded to eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N , is image is part of UPC/EAN library

(required)

"Quantity":

INT,

# Listing quantity ( 1 - max value )

(required)

"StartTime":

"STRING",

# Listing start time printable version

(required)

"StartTimeUnix":

INT,

# Start time , Unixtimestamp

(required)

"StartPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing Start price value

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"NextBid":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Next prossible bid or empty if not applicable

(required)

"Increment":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Increment value

(required)

"BidCount":

INT,

# Count of bids already made

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"BuyNowAvailable":

INT,

# Items quantity available for BuyNow

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price for this Listing

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price exchanged to local currency ( current country view )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price exchanged to current country currency

(required)

"Views":

INT,

# Listing views count ( how many it was viewed on eBid )

(required)

"Description":

"STRING",

# Listing Description

(required)

"Store":

{

"StoreID":

INT,

# Store ID

(required)

"Owner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Store owner

(required)

"Title":

"STRING",

# Store title ( name )

(required)

"Description":

"STRING",

# Store description

(required)

"Category":

INT,

# Store classification category ID ( ebid categories )

(required)

"Image":

"STRING",

# URL of store banner image

(required)

"ListingsCount":

INT,

# Count of listings in this store

(required)

"Link":

"STRING",

# URL to store ( link to eBid )

(required)

"Online":

VALUES SET

# Y/N value is store online

(required)

Y=yes | N=No

# Listing Store

(required)

"StoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Store category where listing listed ( or empty if not in store )

(required)

"ParentStoreCategory":

{

"StoreCategoryID":

INT,

# Store Category ID

(required)

"UserID":

INT,

# Store owner user id

(required)

"Name":

"STRING",

# Store category name

(required)

"Priority":

INT,

# Category priority in listings output (0 - first )

(required)

"ParentID":

INT,

# Parent store category id ( 0 if this is root category )

(required)

"Code":

"STRING",

# User store category code . To refer in bulk uploading etc

(required)

"StoreID":

INT,

# Store ID

(required)

"ItemsCount":

INT,

# Items count in this category

(required)

"HasChildren":

VALUES SET

# Y/N - is this category have subcategories .

(required)

Y=yes | N=No

# Parent Store category where it listed or empty value

(required)

"AutoExtended":

VALUES SET,

# Y/N value , is autoextend set for Listing

(required)

Y=yes | N=No

"Barcode":

"STRING",

# UPC/EAN barcode code or empty value , or special value "EXEMPT"

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"ItemCondition":

{

"ID":

VALUES SET,

# Item condition id , n - new , u - used , s - unused , r - refurbished , '' - any

(required)

n=New | u=Used | s=Unused | r=Refurbished | =Any

"Name":

"STRING",

# Printable name of option

(required)

"APIName":

"STRING"

# API name to refer for API ( NEW , USED, UNUSED, REFURBISHED, ANY )

(required)

# Listing item condition

(required)

"PaymentOptions":

{

"PaymentOption":

[{

"ID":

INT,

# Option ID

(required)

"Name":

"STRING"

# Option name

(required)

}]

(required)

# Payment options available for listing

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"ShipTo":

VALUES SET,

# ISO country code for which current shipping price calculated

(required)

"ShipToName":

"STRING",

# Country name to which current shipping prices calculated

(required)

"ShipToZip":

"STRING",

# zip/postcode to which current shipping price calculated ( if required or present ).

(required)

"Shippings":

{

"DomesticShippings":

{

"Type":

"STRING",

# constant - "calculated"

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions (cm , or inch)

(required)

"Weight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Package weight ( for some countries is kg and gramms )

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

"STRING",

# Package girth ( inch )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Fedex package options or empty values

(optional)

}],

(required)

"PackageName":

"STRING"

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"DomesticShippings":

{

"Type":

"STRING",

# "flat" - is hardcoded , can be used to indefiny shipping type

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service ID

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL

# Extra item shipping price ( if different then 1st item shipping price and if multi item listing )

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# shipping object type , hardcoded value "calculated"

(required)

"Handling":

DECIMAL,

# handling price

(required)

"Dimensions":

{

"X":

DECIMAL,

(required)

"Y":

DECIMAL,

(required)

"Z":

DECIMAL

(required)

# Package dimensions ( in cm or inch depend from country )

(required)

"Weight":

{

"Lbs":

"STRING",

(required)

"Oz":

"STRING"

(required)

# Package weigh lb & oz or kg and gramms depend from country

(required)

"PackageSize":

VALUES SET,

# package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

"PackageName":

"STRING",

# Package name ( Letter , Large Envelope, Regular Package, Large Package, Oversize Package )

(required)

"ExtraWeight":

{

"Lbs":

DECIMAL,

(required)

"Oz":

DECIMAL

(required)

# Extra item weight ( if weight of next items placed to package is different then 1st one ), can be either lbs & oz , or kg and gramms depend from country

(required)

"Option":

[{

"ShippingService":

"STRING",

# Shipping service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Machinable":

VALUES SET,

# Y/(empty value) - is package machinable

(required)

Y=Yes | =No (empty value)

"Rectangular":

VALUES SET,

# Y/(empty value) is package rectangular

(required)

Y=Yes | =No (empty value)

"Girth":

DECIMAL,

# Package girth ( if applicable )

(required)

"FedexPackage":

{

"ID":

VALUES SET,

# Fedex package id : 'a' = 'FEDEX_10KG_BOX' , 'b' = 'FEDEX_25KG_BOX' , 'c' = 'FEDEX_BOX' , 'd' = 'FEDEX_ENVELOPE' , 'e' = 'FEDEX_PAK' , 'f' = 'FEDEX_TUBE' , 'g' = 'YOUR_PACKAGING'

(required)

"Type":

VALUES SET,

# Package type id : FEDEX_10KG_BOX, FEDEX_25KG_BOX, FEDEX_BOX, FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING

(required)

"Name":

"STRING"

# Fedex package name

(required)

# Options filled only if package is fedex

(required)

}]

(required)

"InternationalShippings":

{

"Type":

"STRING",

# postage type , hardcoded value "flat"

(required)

"Option":

[{

"ShippingService":

"STRING",

# Postage service eBid code

(required)

"Name":

"STRING",

# Shipping service name

(required)

"Price":

DECIMAL,

# Shipping price

(required)

"ExtraItemPrice":

DECIMAL,

# Extra item shipping price ( if quantity more then 1 and shipping price is different then 1st item )

(required)

"AvailableTo":

VALUES SET

# Comma separated ISO country lists to which this shipping possible ( like "uk,us,de" )

(required)

}]

(required)

"Shipping":

{

"Code":

"STRING",

# Shipping method eBid code

(required)

"Name":

"STRING",

# Shipping method postage name ( like Royal Mail 1st Class , Parcelforce (2 Day Delivery) , etc )

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"PriceExchanged":

"STRING",

# Shipping price exchanged to current site currency

(required)

"Calculated":

"STRING",

# Y/N - is price received from postage service provider ( N - defined directly by user )

(required)

"ShippingTo":

"STRING",

# ISO Country code for this shipping price ( like uk , us, etc )

(required)

"ShippingToName":

"STRING",

# Country Name for this shipping price ( like United States , Canada , etc )

(required)

"ExtraDetails":

"STRING"

# Extar details for this postage method ( Not available or to be calculated ) , can replace price by this text

(required)

}

(required)

# Listing shipping data . Depend from parameters and listing shipping data this tag may include different optional shipping parameters.

(required)

"MinShippingCost":

"STRING",

# Minimal shipping cost for this listing to choosed or default country

(required)

"MinShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"MinShippingCostName":

"STRING",

# Minimal shipping cost postage method ( printable label like "Royal Mail Airmail" ...)

(required)

"UserListingsCount":

INT,

# Listings count for this listing , is optional depend from parameters.

(optional)

"ShipZipRequiredDom":

VALUES SET,

# Y/(empty value) , is zip postacode required to calculate Domestic shipping prices

(required)

Y=Yes | =No (empty value)

"ShipZipRequiredInt":

VALUES SET,

# Y/(empty value) is zip/postcode required to calculate international price

(required)

Y=Yes | =No (empty value)

"Bids":

{

"Bid":

[{

"BidID":

INT,

# Bid ID

(required)

"BuyNow":

VALUES SET,

# Y/(empty value) - is this buynow bid record

(required)

Y=Yes | =No (empty value)

"UserID":

INT,

# Bidder UserID ( possible 0 - when name hidden , adult listings)

(required)

"Username":

"STRING",

# Bidder username

(required)

"UnixTime":

"STRING",

# Unix Timestamp when bid made

(required)

"Amount":

"STRING",

# Bid amount , possible value "Not Public" for non public values

(required)

"Allocation":

INT,

# Quandtity allocated by this bid ( for dutch listings possible less then quantity )

(required)

"Quantity":

INT,

# Bid quantity

(required)

"QuantityText":

"STRING",

# Printable bid quantity , use to output

(required)

"Time":

"STRING",

# Printable bid time

(required)

"MAO":

VALUES SET,

# Y/(empty value) - is bid generated by successful offer

(required)

Y=Yes | =No (empty value)

"IconType":

VALUES SET,

# Bid icon type - p, r, b ( proxy , reserve meet , buynow )

(required)

p=Proxy | r=Reserve meet | b=Buynow

"IconImages":

"STRING",

# Icon images tags , include IMG tage , possible few together.

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Bidder user object , may not be here if private listing , or can be full version if some params present.

(optional)

"HiddenName":

VALUES SET,

# Y/(empty value) - is name hidden

(required)

Y=Yes | =No (empty value)

"NotPublic":

VALUES SET,

# Y/(empty value) - is amount public or no

(required)

Y=Yes | =No (empty value)

"BuyerFullInfo":

VALUES SET

# Y/(empty value) - is User tag include full version of user object

(required)

Y=Yes | =No (empty value)

}]

(required)

# Bids history for this listing , only if it required in initial query , or empty value

(required)

"Type":

VALUES SET,

# "n" or "d" char , Listing type n-single item listing , d - multi item listing

(required)

n=Single item listing | d=Multi item listing

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing/listing price

(required)

"AdultHiddenName":

[{

"UserID":

INT,

# UserID

(required)

"Username":

"STRING"

# Hidden name replacement like "hiddenname1"

(required)

}],

(required)

"AdultHide":

"STRING",

# Y/N value - is listing opted as Adult Hide Usernames

(required)

"ItemsAvailableBid":

INT,

# Quantity available to bid . If holiday notice set - bidding is not available .

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empy value) - is bidding available for this listing now . Do not show bid form if this field is not set to Y.

(required)

Y=Yes | =No (empty value)

"HolidayNotice":

VALUES SET,

# Y/N value . Is User notice is holiday ( user is on vacancy , and bidding not available )

(required)

Y=yes | N=No

"HolidayNoticeText":

"STRING",

# Holiday notice text , If notify is present then user text or empty.

(required)

"Watch":

VALUES SET,

# Y/N value , is current user watching this listing , only if login info sent with request .

(required)

Y=yes | N=No

"ListingStateSuccess":

VALUES SET,

# Y/N value , is this listing for current user is success ( high bidder , buyed via buynow ) , empty value if user login info not sent with query

(required)

Y=yes | N=No

"ListingStateMessage":

"STRING",

# Listing status message normally shown on eBid listing page at top , only for logged in users ( if login info sent with query )

(required)

"ListingQuestionState":

"STRING",

# Listing question state , only if login data sent with this query e.q. for logged info only . Or empty.

(required)

"Live":

VALUES SET,

# Y/(empty value) - is listing live , e.q. running . listing is live while it not moved to myeBid closed area ( not just time expired ).

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/N value - Is seller accept offers for this listing .

(required)

Y=yes | N=No

"OffersStatus":

"STRING",

# Offers status normally shown at top of eBid listing page , is not empty if seller accept offers , some offer made , and user logged in ( logged info sent with query )

(required)

"OffersAttentionRequired":

VALUES SET,

# Y/N value , is current offers required logged user attention . For example seller attention required when offers made . Is set only if logged user info provided with query.

(required)

Y=yes | N=No

"OffersHistoryCount":

INT,

# How many offers made for this listing/listing

(required)

"PrimaryMarket":

VALUES SET,

# Primary market ISO country code like "us" , "uk" , "eu" ...

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list like "us,uk,eu" or similar . Listing is available on these eBid markets .

(required)

"ASL":

[{

"Sale":

{

"SaleID":

INT,

# Sale ID

(required)

"Buyer":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Buyer info

(required)

"UnixTime":

INT,

# Unix Timestamp when sale made

(required)

"Time":

"STRING",

# Printable when sale made

(required)

"PurchasePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price

(required)

"PurchasePriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Item purchase price exchanged to current country currency

(required)

"Quantity":

INT,

# Quantity of items purchased

(required)

"ShippingPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price

(required)

"ShippingPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Shipping price exchanged to current country currency

(required)

"TotalAmount":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Total sale amount

(required)

"TotalAmountExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Sale total Amount exchanged to current country currency

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

}

# Items Seller object

(required)

"Status":

{

"InvoiceStatus":

VALUES SET,

# Y/N value is invoice sent

(required)

Y=yes | N=No

"InvoiceStatusText":

"STRING",

# is invoice sent - Yes/No text status

(required)

"PaymentStatus":

VALUES SET,

# C/R/NP/Y/YN/N values where C - Cancelled, R - Refunded, NP - Non Payed , Y - Payed, YN - Pending , N - Not Yet

(required)

"PaymentStatusText":

"STRING",

# Payment status printable text - Cancelled / Refunded / Non Payed / Payed / Pending / Not Yet

(required)

"ShipmentStatus":

VALUES SET,

# Y/N/C - is item shipped - yes , no , cancelled

(required)

Y=Shipped | N=Not Shipped | C=Cancelled

"ShipmentStatusText":

"STRING",

# text value for shipment status - Yes / No / Cancelled

(required)

"FeedbackLeftStatus":

VALUES SET,

# Is feedback left by current user - Y/N/C - Yes, No , Cancelled

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackLeftStatusText":

"STRING",

# Is feedback leaved by current user - Yes / No / Cancelled

(required)

"FeedbackReceivedStatus":

VALUES SET,

# Y/N/C - is current user received feedback for this item ( Yes / No / Cancelled )

(required)

Y=Yes | N=No | C=Cancelled

"FeedbackReceivedStatusText":

"STRING"

# printable feedback received for this item status - Yes / No / Cancelled

(required)

"AvailableOptions":

{

"Option":

[{

"ID":

INT,

# ASL option ID

(required)

"Code":

VALUES SET,

# ASL string code like (PayNowViaPPPay, RequestInvoiceFromSeller ...) , use this to make all checks in code.

(required)

"Text":

"STRING",

# Option title ( use to show on screen as choose option )

(required)

"ExtraParam":

"STRING",

# Some extra params for option , currently used only for question reply and include question ID .

(required)

"TextNeed":

VALUES SET

(required)

Y=user required enter text | N=text is not need | C=option cannot be submit

}]

(required)

# Available after sale actions

(required)

"Log":

{

"Message":

[{

"ID":

INT,

# ASL log entry ID

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# ASL log user ( who logged )

(required)

"UnixTime":

INT,

# Unix timestamp when entry added

(required)

"Time":

"STRING",

# Printable time when log entry added

(required)

"Type":

VALUES SET,

# A numeric value relating to the type of ASL entry.

(required)

"TextType":

"STRING",

# Log entry type ( printable text )

(required)

"Details":

"STRING",

# Log entry message ( entered by user or generated )

(required)

"ReplyTo":

INT,

# ReplyID to some other log entry ( only for questions replies )

(required)

"NudgeCount":

INT,

# Nudge count ( questions only )

(required)

"LastNudgeUnixTime":

INT,

# Unix Timestamp of last nudge ( questions only )

(required)

"LastNudge":

"STRING",

# Last nudge time ( printable format )

(required)

"FeedbackMessage":

"STRING"

# Feedback message ( only for feedbacks )

(required)

}]

(required)

# ASL Log entry

(required)

}],

(required)

"ReservePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing reserve price .

(required)

"AutoOfferAcceptPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers auto accept price

(required)

"AutoOfferDeclinePrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Offers Auto decline price

(required)

"ToRepostCount":

INT,

# Count of autoreposts still due for this listing

(required)

"ToRepostOriginalCount":

INT,

# Initial value of count of listing autoreposts

(required)

"BuynowDiscount":

DECIMAL,

# Current buynow discount rate , is percent from 0 to 99.9

(required)

"ItemSpecificRaw":

"STRING",

# Item specific string , color , sizes , etc . Same format as for bulk upload .

(required)

"Duration":

{

"Days":

INT,

# Days

(required)

"Hours":

INT,

# Hours , available to Seller+ accounts only

(required)

"Mins":

INT,

# Mins , available for Seller+ accounts only

(required)

"UntilSold":

VALUES SET,

# Y/(empty value ) is this listing is Run Until Sold , if so then Days/Hours/Mins is empty

(required)

Y=Yes | =No (empty value)

"AutoExtend":

VALUES SET

# Y/N value , is listing auto extended when busy bids made.

(required)

Y=yes | N=No

# Original listing duration

(required)

"StartListing":

{

"Type":

VALUES SET

# Listing start options : "immediately" , "onfirstbid"

(required)

immediate=Immediate | onfirstbid=On firts bid | custom=Custom time

# Listing start information

(required)

"Tax":

[{

"State":

"STRING",

# Tax state code ( like NY, FL etc )

(required)

"Rate":

DECIMAL,

# Tax rate ( percent )

(required)

"ApplyToShipping":

VALUES SET

# Y/(empty value) - is tax applied to shipping also

(required)

Y=Yes | =No (empty value)

}],

(required)

"URL":

"STRING",

# Listing URL pointed to eBid listing page

(required)

"QuestionsCount":

INT,

# Questions count or empty value. Questions count provided only with options "QuestionsCount=Y" or "QuestionsHistory=Y"

(required)

"Questions":

{

"QuestionID":

INT,

# Question ID

(required)

"ListingID":

INT,

# Listing ID

(required)

"Poster":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Question poster ( user object )

(required)

"UnixTime":

INT,

# Unixtimestamp time when question/reply posted

(required)

"Time":

"STRING",

# Printable question/reply time

(required)

"Message":

"STRING",

# Question/Reply text

(required)

"ReplyToID":

INT,

# ID of question replied or empty if is not reply

(required)

"NudgeCount":

INT,

# Nudge count ( how many times user nudged question )

(required)

"LastNudgeUnixTime":

INT,

# Unix timestamp when question last nudged

(required)

"LastNudgeTime":

"STRING"

# Printable time when question last time nudged

(required)

# Is quertion history only if option "QuestionsHistory=Y"

(required)

"DispatchTime":

{

"Code":

VALUES SET,

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(required)

"Label":

"STRING"

# Dispatch time information ( text ) as shown on eBid Listing pages

(required)

# Item dispatch time information

(required)

"ReturnPolicy":

{

"Code":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(required)

"Label":

"STRING"

# Return policy text

(required)

# Return policy information

(required)

"CategoryPath":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# opted by option "FullCategoryPath=Y"

(required)

"CategoryPath2":

{

[

"Category":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

(optional)

]

# Category path for second category , if category present and query opted with 'FullCategoryPath=Y'

(required)

"RepostedIDs":

"STRING",

# If listing is closed and in request option RepostedIDs=Y was set , then it return comma separated list of ids of listings reposted from this one . Most recently reposted is first in the list .

(optional)

"Variations":

{

"ImageTag":

"STRING",

# Variation image tag

(required)

[

"Variation":

{

"Image":

{

"ImageLarge":

"STRING",

# Big image URL

(required)

"ImageSmall":

"STRING",

# Small image URL

(required)

"ImageMedium":

"STRING",

# Medium image URL

(required)

"eBidImage":

VALUES SET

# Is image stored at eBid servers ? Y/N

(required)

Y=yes | N=No

# Image info

(optional)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Variation price

(required)

"Quantity":

INT,

# Items quantity

(required)

"QuantitySold":

INT,

# Quantity already Sold

(required)

"Barcode":

"STRING",

# UPC/EAN/MPN code

(required)

"ItemSpecifics":

{

"Name":

"STRING",

# Attribute name

(required)

"Value":

"STRING"

# Attribute value

(required)

# Variation specifics

(required)

]

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING",

# Variation Maximum Price (added in 2.0)

(required)

"ItemSpecifics":

[{

"Name":

"STRING",

# Tag name

(required)

"Value":

"STRING"

# Tag value

(required)

}]

(required)

}

(required)

}

SaveListingNewMultiple
Saving up to 500 listings at time , is preferable when you need run many listings , it work faster then run single by single listings .

API Command: SaveListingNewMultiple
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "SaveListingNewMultiple" ,

"LoginKey":

"STRING",

# User Login Key

(required)

[

"Listing":

{

"CategoryID":

INT,

# Categry ID

(required)

"Title":

"STRING",

# Listing title

(required)

"Description":

"STRING",

# Listing description

(required)

"Quantity":

INT,

# Quantity to sel , max 99 items

(required)

"Duration":

{

"Days":

INT,

# Days

(required)

"Hours":

INT,

# Hours

(optional)

"Mins":

INT,

# Mins

(optional)

"AutoExtend":

VALUES SET,

# Y/N value . is listing autoextented when busy bids made near listing end

(optional)

Y=yes | N=No

"UntilSold":

VALUES SET

# Y/N value . Sell till sold . Days / hours then not need and StartListing Type tag must me 'immediatelly'

(optional)

Y=yes | N=No

# Listing duration

(optional)

"Duration":

INT,

# Is other way to specify duration - just days

(optional)

"StartBid":

DECIMAL,

# Starting price

(optional)

"ReservePrice":

DECIMAL,

# Reserve price . Multi-item listings does not have reserve price.

(optional)

"Feature":

VALUES SET,

# Listing feature : 'none' , 'special', 'gallery', 'platinum', 'standard' , 'front'

(optional)

"BuyNowPrice":

DECIMAL,

# Listing BuyNow price

(optional)

"Brand":

"STRING",

# Item brand like 'microsoft' , 'dell'

(optional)

"Store":

{

"StoreID":

INT,

# Store id where to list listing

(required)

"StoreCategory":

INT

# Store category id where list listing

(required)

(optional)

"AdultHide":

VALUES SET,

# Y/N value . If listing is adult , need hide bidder usernames.

(optional)

Y=yes | N=No

"ItemCondition":

VALUES SET,

# Item conditional , possible values : 'New','Used','Unused','Refurbished'

(optional)

n=New | u=Used | s=Unused | r=Refurbished | =Any

"Images":

{

"MainImage":

"STRING",

# URL to primary (thumbnail) image. This can be an eBid hosted image or alternatively an image from anywhere on the internet which we will then place into a queue for downloading to the eBid servers.

(required)

"Image":

["STRING"]

(optional)

"Extras":

{

"Bold":

VALUES SET,

# Y/N value . Feature listing listing as bold .

(optional)

Y=yes | N=No

"Highlight":

VALUES SET,

# Y/N value . Highlight listing in results .

(optional)

Y=yes | N=No

"Images":

{

"Image":

["STRING"]

# URL to image . These images extra charged.

(required)

(optional)

"CategoryID":

"STRING",

# Second category ID for listing .

(optional)

"SubTitle":

"STRING"

# Listing subtitle

(optional)

# Listing extra features , similar to section four of ebid listing start form .

(optional)

"Movie":

"STRING",

# URL to video . 11 character YouTube id number for your movie .

(optional)

"SKU":

"STRING",

# Your SKU ( any value up to 100 chars )

(optional)

"NoReserve":

VALUES SET,

# Y/(empty value ) - listing have no reserve price . Alternative - just do not specify ReservePrice field

(optional)

Y=yes | N=No

"RepostCount":

INT,

# Number of auto reposts for this listing . 0-10 times.

(optional)

"StartListing":

{

"Type":

VALUES SET,

# Possible values : 'custom', 'onfirstbid' , 'immediate' . Custom require to set start time .Onfirst bid and immediatelly listings use duration from Duration field.

(required)

immediate=Immediate | onfirstbid=On firts bid | custom=Custom time

"Date":

"STRING"

# date when listing start , only for 'Custom' . Format is YYYY-MM-DD hh:mm:ss .

(required)

# Listing start time

(optional)

"Tax":

{

"State":

"STRING",

# State code like NY, FL etc

(required)

"Rate":

DECIMAL,

# Tax rate 0 - 99.9 percents.

(required)

"ApplyToShipping":

VALUES SET

# Y/N value - is tax applied also to shippings .

(required)

Y=yes | N=No

# Tax information ( only for countries that support tax calculations or error will return )

(optional)

"PaymentMethod":

"STRING",

# Comma separated payment methods codes . to retrieve all see query : GetPaymentOptionsValues .

(required)

"DomesticShippings":

{

"Type":

"STRING",

# possible values 'flat' ( fixed rates ) or 'calculated'( calculate by weight for some countries/services )

(required)

"DomesticShipping":

[{

"Price":

DECIMAL,

# Shipping price

(required)

"ShippingService":

"STRING",

# Shipping service eBid code , see query GetShippingOptionsValues , to retrieve all codes .

(required)

"ExtraItemPrice":

DECIMAL

# Price for 2nd item in the package , for multi item listings only and if price is different then 1nd item .

(required)

}],

# Flat domestic type input

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

INT,

(required)

"Y":

INT,

(required)

"Z":

INT

(required)

# Package sizes , not required for some postage methods

(optional)

"Weight":

{

"Lbs":

INT,

# Lbs or kg

(required)

"Oz":

INT

# Oz or gramms depend from site

(required)

# Package weight , in current sire weight units ( lb + oz , or kg + gramms )

(required)

"ExtraWeight":

{

"Lbs":

INT,

# Lbs or kg depend from site

(required)

"Oz":

INT

# Oz or gramms depend from site

(required)

# Weight for 2nd and next items for multi item listings and if weight different then 1st item .

(optional)

"PackageSize":

VALUES SET,

# eBid package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

[

"Option":

{

"ShippingService":

"STRING",

# Shipping service code , see query GetShippingOptionsValues to get all options

(required)

"Machinable":

VALUES SET,

# Y/N value , is package machinable ( required for some postage methods )

(optional)

Y=yes | N=No

"Rectangular":

VALUES SET,

# Y/N value is package rectangular . If so , then need set also Girth field.

(optional)

Y=yes | N=No

"Girth":

INT,

# Girth

(optional)

"FedexPackage":

VALUES SET

# fedex package eBid code

(required)

}

(required)

]

# Domestic shipping

(required)

"InternationalShippings":

{

"Type":

"STRING",

# 'flat' or 'calculated' , depend from type need read other fields. Calculated is for some services that can be calculated by weight .

(required)

"InternationalShipping":

[{

"Price":

DECIMAL,

# Shipping price

(required)

"ShippingService":

"STRING",

# eBid shipping service code . to see all codes - query : GetShippingOptionsValues

(required)

"AvailableTo":

VALUES SET,

# Comma separated ISO country list codes , like "uk,us,eu"

(required)

"ExtraItemPrice":

DECIMAL

# Price for shipping 2nd and next item for multi item listings and if shipping price is different then for 1nd item

(required)

}],

(required)

"Handling":

DECIMAL,

# Handling price

(required)

"Dimensions":

{

"X":

INT,

(required)

"Y":

INT,

(required)

"Z":

INT

(required)

# Package dimenstions . in inch or in cm depend from site measure units

(required)

"Weight":

{

"Lbs":

"STRING",

# Lbs or Kg depend from weight units

(required)

"Oz":

"STRING"

# Oz or gramms

(required)

# Package weight ( lbs + oz , or kg + gramms ) depend from site weight unit .

(required)

"ExtraWeight":

{

"Lbs":

INT,

# Lbs or kg depend from site weight units

(required)

"Oz":

INT

# Oz or gramms depend from site measure units

(required)

# Shipping weight for 2nd and next item in the package , only for multi item listings and if 2nd package weight is different from 1st .

(optional)

"PackageSize":

VALUES SET,

# eBid package size code : a = Letter , b = Large Envelope, d = Regular Package, e = Large Package, f = Oversize Package

(required)

a=Letter | b=Large Envelope | d=Regular Package | e=Large Package | f=Oversize Package

[

"InternationalShipping":

{

"ShippingService":

"STRING",

# Shipping service code , to see all query : GetShippingOptionsValues

(required)

"AvailableTo":

VALUES SET,

# Comma separated country list to which shipping available like "uk,us,eu"

(required)

"Machinable":

VALUES SET,

# Y/N value , is package machinable , required for some shippings services only

(optional)

Y=yes | N=No

"Rectangular":

VALUES SET,

# Y/N value , is package rectangular , if so , then need specify also Girth

(optional)

Y=yes | N=No

"FedexPackage":

VALUES SET

# eBid Fedex package code ( fedex packages only )

(optional)

}

(required)

]

(optional)

"AcceptOffers":

VALUES SET,

# Y/N value , if seller accept offers for this listing

(optional)

Y=yes | N=No

"AutoOfferAcceptPrice":

DECIMAL,

# Auto accept offers price if seller accept offers .

(optional)

"AutoOfferDeclinePrice":

DECIMAL,

# Auto decline price if seller accept offers .

(optional)

"Barcode":

"STRING",

# Item EAN/UPC barcode , of special value 'exempt' if barcode not applicable for item ( unique , handmade , rarity )

(optional)

"ItemSpecificRaw":

"STRING",

# Item spcific attributes in eBid format ( color , sizes , etc )

(optional)

"DispatchTime":

VALUES SET,

# Dispatch time code 0 - Not given, 1 - Same Day, 2-Next Day, 3 - 2 Days, 4 - 3 Days, 5 - 4 Days , 6 - More than 4 Days

(optional)

"ReturnPolicy":

INT,

# Return policy code , 0 - no return policy , 1 - no returns accepted , 2 - eBid default policy , 3 and later is user defined in myEbid

(optional)

"RepostListingID":

INT,

# If this listing is repost copy of some closed listing this field include original listing ID.

(optional)

"Currency":

"STRING",

# Currency code like USD , EUR

(optional)

[

"ItemSpecifics": # (added in 2.0)

{

"Name":

"STRING",

# Specifics tag name

(required)

"Value":

"STRING"

# Specifics Value

(required)

# (added in 2.0)

(optional)

]

"Variations": # (added in 2.0)

{

[

"Variation":

{

"Image":

["STRING"],

# Variation Image

(optional)

"Price":

DECIMAL,

# Variation Price

(required)

"Barcode":

"STRING",

# ISBN/UPC/EAN/MPN code

(optional)

"Quantity":

INT,

# Variation Quantity

(required)

[

"ItemSpecifics":

{

"Name":

"STRING",

# Specifics Tag name

(required)

"Value":

"STRING"

# Specifics value

(required)

# Variation Specifics

(required)

]

# Variation Data

(required)

]

}

# (added in 2.0)

(optional)

# Listing data

(required)

]

}

RESPONSE

{
"APIVersion": "",

"ErrorCount":

INT,

# Error count in response

(required)

"SuccessCount":

"STRING",

# Success count in response

(required)

"Listing":

[{

"ListingID":

INT,

# Listing ID

(required)

"Title":

"STRING",

# Listing title

(required)

"Listing Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Price exchanged to local currency

(required)

"Quantity":

INT,

# Quantity

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Listing category

(required)

"PrimaryImageLarge":

"STRING",

# Primary Image link ( large )

(required)

"PrimaryImageSmall":

"STRING",

# Primary Image url ( small )

(required)

"PrimaryImageMedium":

"STRING",

# Primary Image URL ( medium )

(required)

"PrimaryImageIseBid":

VALUES SET,

# Is primary image stored at eBid servers Y/N

(required)

Y=yes | N=No

"SKU":

"STRING"

# User defined SKU sent in query . Possible to identify listings by this field.

(required)

}]

(required)

}

UploadImage
This method allows the uploading of images/photos to a users "My Gallery" section and therefore to be used within a listing on a eBid. This function uploads images via URL or as attached binary data. Uploading photo by URL the data is sent as a normal xml/json request. If photo is sent as binary attachment it will need to use multipart/mime format. In first part of the upload use a normal xml/json request, in the second part is attached image binary data. Note : this uses a different API URL than most other API methods.

UploadImageHTML
This is our second image upload method, this is a standard HTML form upload and different to our other xml/json function. It is designed to send data directly from a web application. There is an issue with javscript however, elements cannot manipulate data for security reasons. So, to send this query with image attached programmers will need send form almost as it is.

On input this following HTML fields are accepted :

AppId - app id

AppKey - app key

LoginKey - login key received upon login procedure

ResponseType - response type ( xml or json value ), in which format response you expect.

Folder - folder where image to save ( same as myGallery usr folders , optional )

Some manipulations with data in javascript may be helpful :

var formData = new FormData();
var element = document.getElementById('image');
var files = element.files;

for (var ii = 0, file; file = files[ii]; ++ii)
{
formData.append('image', file);
}

formData.append( "LoginKey", loginInfo.LoginKey );
formData.append( "ResponseType", 'json' );
formData.append( "AppId", this.AppId );
formData.append( "AppKey", this.AppKey );

$.ajax({
url: 'api.ebid.net/image';
type: 'POST',
timeout: 120000,
xhr: function() { // custom xhr
myXhr = $.ajaxSettings.xhr();
return myXhr;
},
data: formData,
cache: false,
contentType: false,
processData: false,

.......
}

USER Methods
eBid API methods relating to individual users/members of eBid.

GetUserAgreement
Return eBid Terms & Conditions agreement that new users must agree to before registering a new account.

GetUserFeedback
Returns feedback information about a user. Includes positive/neutral/negative counts and feedback text entries between "Start" and "Limit" counts.

API Command: GetUserFeedback
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetUserFeedback" ,

"UserID":

"STRING",

# User ID

(required)

"Start":

INT,

# Offset of feeback table . For navigation.

(optional)

"Limit":

INT

# Feedback count to return , max 50 feedbacks per request.

(optional)

}

RESPONSE

{
"APIVersion": "",

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# User for who feedback table requested

(required)

"TotalFeedbacks":

INT,

# Total feedbacks posted about user ( amount of records )

(required)

"PositiveFeedbacks":

INT,

# Positive feedbacks posted about user

(required)

"NeutralFeedbacks":

INT,

# Neutral feedbacks posted about user

(required)

"NegativeFeedbacks":

INT,

# Negative feedbacks posted about user

(required)

"NegativeFeedbacks":

INT,

# Negative feedbacks posted about user

(required)

"Feedbacks":

{

"Feedback":

[{

"PosterID":

INT,

# Feedback Poster User ID

(required)

"RecipientID":

INT,

# Feedback recepient ID

(required)

"Date":

"STRING",

# Feedback printable date

(required)

"UnixTime":

INT,

# feedback time Unix timestamp

(required)

"Title":

"STRING",

# Title of listing for which feedback posted

(required)

"Comment":

"STRING",

# Feedback text entered by poster

(required)

"PosterRole":

"STRING",

# Poster role - s - seller , b - buyer

(required)

"Rate":

INT

# Feedback rate , -1 = negative , +1 = positive , 0 = neutral , can be in range -255 .. +255 for imported feedbacks .

(required)

}]

# Feedback object

(required)

}

GetUserInfo
Returns user information located via "UserID" or "Username" fields, one is required. No private information is returned.

API Command: GetUserInfo
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetUserInfo" ,

"UserID":

INT,

# is optional , need specify userid or username

(optional)

"Username":

"STRING",

# Username , is optional , need specify either or userid or username

(optional)

"NoAdult":

VALUES SET,

# Y/N value . If IncludeStoreInfo set and NoAdult set then adult stores will be no in the list.

(optional)

Y=yes | N=No

"GetItemsRunning":

VALUES SET,

# Y/N value. if Y then tag ItemsRunning will include count of listings running this user . please do not set if not really need

(optional)

Y=yes | N=No

"IncludeStoreInfo":

VALUES SET

# Y/N value. If set to Y then StoreInfo tag will include user stores .

(optional)

Y=yes | N=No

}

RESPONSE

{
"APIVersion": "",

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

"StoreInfo":

{

"Store":

{

"StoreID":

INT,

# Store ID

(required)

"Owner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# Store owner

(required)

"Title":

"STRING",

# Store title ( name )

(required)

"Description":

"STRING",

# Store description

(required)

"Category":

INT,

# Store classification category ID ( ebid categories )

(required)

"Image":

"STRING",

# URL of store banner image

(required)

"ListingsCount":

INT,

# Count of listings in this store

(required)

"Link":

"STRING",

# URL to store ( link to eBid )

(required)

"Online":

VALUES SET

# Y/N value is store online

(required)

Y=yes | N=No

}

(required)

}

# Store information

(required)

}

GetUserListings
This API method returns either a user's listings for sale on eBid or a count of a user's listings within an eBid category, or both depending on the parameters sent in the request. "NeedAuctions" field will force a return of user's listing from "Start" to "RowsLimit", without this option only counts in categories will be returned.

API Command: GetUserListings
URL to call : http://api.ebid.net/trading

QUERY

{
"AppId": "YOUR_APP_ID",
"AppKey": "YOUR_APP_KEY",
"Version": "",
"EbidSite": "STRING",

# 2 Letter eBid site code.

(required)

"Command": "GetUserListings" ,

"CategoryID":

INT,

# Category ID filter

(optional)

"UserID":

INT,

# User ID

(required)

"NeedListings":

VALUES SET,

# Y/N/LowestCategory value. Include listings in response . 'LowestCategory' mean only if current category have no subcategories then include listings.

(optional)

Y=yes | N=No

"NeedCount":

VALUES SET,

# Y/N value. If set then 'Count' tag will include user total listings count.

(optional)

Y=yes | N=No

"NoAdult":

VALUES SET,

# Y/N value. If Y then no adult listings in response

(optional)

Y=yes | N=No

"InClosed":

VALUES SET,

# Y/N value . By default searched live listings . If this field is Y then searched closed listings.

(optional)

Y=yes | N=No

"Start":

INT,

# Start position in search results , 20 mean from 20th listings in search results . Is for page navigation . Default = 0 , from begin.

(optional)

"RowsLimit":

"STRING"

# How many rows return in search result . Is applicable only for listings results , and must not exceed 75 listings per query.

(optional)

}

RESPONSE

{
"APIVersion": "",

"Count":

INT,

# Total listings found for this user ( empty if no option NeedCount is not set to Y )

(required)

"CountCategoriesBelow":

INT,

# Total items is categories searhed

(required)

"Categories":

{

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

# Category suggestions for this user

(required)

"Listings":

{

"ListItem":

[{

"ListingID":

INT,

# Listing ID

(required)

"Title":

"STRING",

# Listing title

(required)

"BidCount":

INT,

# Bids count ( include BuyNow bids )

(required)

"Currency":

"STRING",

# Listing currency code , like USD , GBP , EUR

(required)

"BuyNowAvailable":

INT,

# Quantity of items available for BuyNow option

(required)

"BuyNowPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow price

(required)

"BuyNowPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# BuyNow pprice exchanged to current site currency

(required)

"PrimaryMarket":

"STRING",

# Listing primary market , ISO code like 'us' , 'uk'

(required)

"Price":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Listing current price

(required)

"PriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current price exchanged to current site currency

(required)

"Quantity":

INT,

# Listing Quantity ( all items offered by this listing )

(required)

"Views":

INT,

# Current listing page views

(required)

"ShippingCost":

"STRING",

# Lowest postage price

(required)

"ShippingCostType":

"STRING",

# Postage type as 'DESCRIPTION' - see description, 'CALCULATE' - to be calculated , 'N/A' - not available, 'FREE' - free, 'AMOUNT' - amount

(required)

"TimeLeft":

{

"LeftType":

VALUES SET,

# Lefy type , possible values : RunUntilSold, OnFirstBid, Closed, Time .

(required)

RunUntilSold=Run Until Sold | OnFirstBid = days > 1st bid= | Closed=Listing Closed | Time=Seconds till listing will be closed

"Value":

"STRING",

# Value : RunUntilSold = always 0 , OnFirstBid = days > 1st bid , Closed = always 0 , Time = seconds till listing will be closed

(required)

"Text":

"STRING"

# Printable value for time left

(required)

# Time left to close listing

(required)

"Category":

{

"CategoryID":

INT,

# Category ID

(required)

"CategoryName":

"STRING"

# Category Name

(required)

# Category information

(required)

"Seller":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Seller information

(required)

"PrimaryImageLarge":

"STRING",

# URL to primary image ( large version )

(required)

"PrimaryImageSmall":

"STRING",

# URL to primary image ( small version )

(required)

"PrimaryImageMedium":

"STRING",

# Primary image medium version

(required)

"PrimaryImageIseBid":

"STRING",

# Y/N value is main image stored on eBid servers

(required)

"PrimaryImageIsUPC":

"STRING",

# Y/N value is main image is part of UPC/EAN image library

(required)

"ItemsAvailableBid":

INT,

# Items count available to bid

(required)

"BiddingAvailable":

VALUES SET,

# Y/(empty value ) is bidding available for this listing

(required)

Y=Yes | =No (empty value)

"AcceptOffers":

VALUES SET,

# Y/(empty value) is seller accept offers for this item

(required)

Y=Yes | =No (empty value)

"AvailableTo":

VALUES SET,

# Comma separated countries like "us,uk,eu" or similar for which this listing is available

(required)

"Image":

[{

"ImageLarge":

"STRING",

# URL to image large version

(required)

"ImageSmall":

"STRING",

# URL to small version of image

(required)

"ImageMedium":

"STRING",

# URL to image medium version

(required)

"eBidImage":

"STRING",

# Y/N is image uploaded to eBid servers or to third server(s)

(required)

"UPCImage":

"STRING"

# Y/(empty value) is image part of UPC/EAN image library.

(required)

}],

# Image object

(required)

"tick":

VALUES SET,

# Y/N value , Is this listing is success for current user ( if login info sent with query )

(optional)

Y=yes | N=No

"Winner":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , county ... )

(required)

"Since":

"STRING",

# Printable date when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined

(required)

"AccType":

VALUES SET,

# account type - B - bussiness , P - private

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# User buddy point balance

(required)

"Link":

"STRING",

# URL to eBid their all about

(required)

"UserRating":

INT,

# User rating

(required)

"MostRecentActivity":

"STRING"

# Printable time of last user activity

(required)

# Current winner of listing ( if there is )

(optional)

"CurrentPrice":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current Listing price , is optional if user logged in

(optional)

"CurrentPriceExchanged":

{

"Amount":

DECIMAL,

# Amount

(required)

"CurrencyCode":

VALUES SET,

# ISO currency code ( like EUR , USD , etc ... )or special code BDP - eBid buddy points

(required)

"CurrencySign":

"STRING",

# Currency sign to print

(required)

"CurrencyEmailSign":

"STRING",

# Currency sign for texts and emails

(required)

"CurrencyName":

"STRING"

# Currency name like Euros, US Dollars, etc ...

(required)

# Current listing price , is present only user logged in ( login information sent with query )

(optional)

"UnixTimeEnd":

INT,

# Listing end time , is unix timestamp or special value , 2000000000 = Run Until Sold , 2000000001 - 1 day after 1st bid , 2000000002 - 2 days after 1st bid , etc

(required)

"TimeEnd":

"STRING",

# Listing end time in printable format

(required)

"Feature":

VALUES SET,

# Listing feature values (code): none, normal, special, front, happyhours, gallery, 60minutes, standard, platinum, joblot, buddy

(required)

"FeatureText":

"STRING",

# Listing feature - printable version

(required)

"URL":

"STRING",

# URL to listing page on eBid main site

(required)

"SKU":

"STRING",

# Listing SKU code

(required)

"VariationsMinPrice":

"STRING",

# Variation Minimal Price (added in 2.0)

(required)

"VariationsMaxPrice":

"STRING"

# Variation Max Price (added in 2.0)

(required)

}]

(required)

# Filled with listings only if option 'NeedListings=Y'

(required)

"User":

{

"UserID":

INT,

# User ID

(required)

"Username":

"STRING",

# Username

(required)

"Location":

"STRING",

# User location ( country , city ... )

(required)

"Since":

"STRING",

# Printable time when user joined eBid

(required)

"SinceUnixTime":

INT,

# Unix timestamp when user joined eBid

(required)

"AccType":

VALUES SET,

# User account type , P = private , B = Business

(required)

B=Business Usage | P=Personal Usage

"BuddyPoints":

DECIMAL,

# Buddy points account balance

(required)

"Link":

"STRING",

# URL to user all about page at eBid

(required)

"Description":

"STRING",

# User all about info

(required)

"UserRating":

INT,

# User rating , above zero is positive , below zero is negative

(required)

"Country":

"STRING",

# User country ( entered on registraion )

(required)

"UserPicture":

"STRING",

# URL to user all about picture

(required)

"Home":

VALUES SET,

# eBid site where user registered , two letter ISO code , like uk, us, eu .... etc...

(required)

"ItemsRunning":

INT,

# How many items currently running by this user ( only GetUserInfo request , other may keep it empty

(required)

"AV":

VALUES SET,

# Is address partially confirmed for user - N - not tested , F - failed , Y - confirmed .

(required)

Y=Matched | N=Not checked | F=Failed

"MostRecentActivity":

"STRING",

# Printable time of user most recent activity

(required)

"Userlevel":

VALUES SET,

# Userlevel code : 0 - Buyer , 1 - Seller , 3 - Seller+

(required)

0=Buyer | 1=Seller | 3=Seller+

"UserlevelText":

VALUES SET

# Userlevel : Buyer , Seller , Seller+

(required)

Buyer=BUYER | Seller=SELLER | Seller+=SELLER+

# User info for searched user listings

(required)

"CategoryID":

INT,

# Categiry ID

(required)

"Name":

"STRING",

# Category Name

(required)

"ParentID":

INT,

# Category parent ID , zero if have no parent category ( root category )

(required)

"ParentList":

"STRING",

# comma separated list of parent categories , or empty if root

(required)

"AllowPost":

VALUES SET,

# Y/N , is category allowed to post listing here

(required)

Y=yes | N=No

"FullName":

"STRING",

# Category full name ( include all path of subcategories, catgeory : subcategory : subcategory ... )

(required)

"SubcategoryName":

"STRING",

# Subcategory name , similar to fullname tag but without root category

(required)

"ItemsCount":

INT

# Items count in this category

(required)

}

AFTER SALE LOG Methods eBid API methods that relate to the after sale process, once a sale has been agreed. Payment, making contact, feedback etc.

GetListingASL Returns the ASL (After Sale Log) details for a given listing. If more than one sale has been made this will return more than one ASL.

BUYING Methods eBid API methods that enable or are related to BuyNow, Bidding and Offering (MaO).

SaveBid This API method allows a bid to be saved on an eBid auction listing.

SaveBuyNow This API method allows a BuyNow to be recored on alisting.

SaveCheckoutSubmit This method takes the data submitted from "GetCheckoutData" and will return a URL to redirect to to make payment.

SaveOffer This API method allows an offer (MaO)to be recorded on a listing the has the Make an Offer (MaO) facility switched on.

SaveOfferBuyerAcceptReject This method is used when a buyer wishes to acceptor reject a counter offer (MaO) they have received from a seller.

SaveOfferSellerAcceptReject This method is used when a seller wishes to accept, reject or make a counter offer on a offer (MaO) they have received.

EBID STORE Methods eBid API methods relating to eBid Stores.

GetEbidStoreCategories This API method returns all eBid Store categories in a given eBid Store or the subcategories below a certain hierarchy level if "ParentStoreCategoryID" is set.

GetEbidStoreCategoryList Returns the number of eBid Stores located in a certain category. Every eBid Store is categorised based on the items it sells when creating the store.

GetEbidStores Returns information about a single eBid Store or alternatively a list of eBid Stores owned by a single user.

SearchEbidStores This API method will search eBid Stores according to keywords located in the title of the eBid Store.

ITEM Methods These functions does not require login and return listings data

GetListingBids Returns all listing bids, BuyNows and successful accepted MaO (offers). If "LoginKey" (user is logged in) field is sent in request then the response will house more information.

GetListingMultiple Similar to "GetListingSingle" but only for live listings, but retrieves data for multiple listings in a single call. Send multiple "ListingID" instances within your request comma delimited. Will not return closed listing data.

GetListingOffers This method returns offers (MaO) made on a listing. This will show all offers including pending, rejected, accepted, countered.

LOGIN Methods eBid API methods to allow a user login session to be created. A Session ID is required first then a login can take place via redirecting your user to the LoginURL returned.

CheckLoginKey Is the current "LoginKey" still valid and not expired? Eg. is the user still logged in?

GetLoginKey This method returns a "LoginKey" based on the "SessionID" sent in the request. It's the last pasrt of the authorization process. The "LoginKey" must be stored securely at the client side and added to any relevant requests that require a login to process. It cannot be requested twice.

GetSessionID SessionID is a 32 character random string generated by the API. A success ("ReturnURL") and failed/cancelled ("RetunCancelURL") are required to redirect after a good/bad login.

MY EBID Methods eBid API methods relating to user account administration similar to the "My eBid" section of the eBid website.

GetMyEbidBidsMade Returns an array of listings on which the current user has pending bids. This will not include bids that won auctions.

GetMyEbidBidsReceived Returns and array of listings on which the user has received bids on items they are selling. Bids will be pending, eg. auction has not closed yet.

GetMyEbidBought Returns an array of listings which have resulted in purchases by this user. Be it BuyNow, successful bids or accepted MaO (offers).

GetMyEbidCounters Returns the most important counts relating to a user's activity. Includes number of bids made, items purchased, offers made, offers received, sold items etc. Similar to the My eBid Dashboard counts on our main site.

GetMyEbidOffersMade Returns an array of listings on which the current user has pending offers (MaO). This will not include offers that were accepted by the seller and changed into purchased items.

GetMyEbidOffersReceived Returns an array of listings on which the current user has pending offers (MaO) received. This will not include offers that were accepted by this user and therefore changed into sold items.

GetMyEbidSold Returns an array of listings which have resulted in sales by this user. Be it BuyNow, successful bids or accepted MaO (offers).

GetMyEbidWatched Returns an array of listings which the user in session is Watching.

GetUserDefaults Returns the data as seen in the My Defaults > My Selling Defaults section of My eBid on our main website. These are saved listing details, eg. title and price that are used to populate the listing form when putting an item up for sale.

SaveQuestionNew Allows a user to ask a question relating to a live listing, or reply to a question already asked.

SaveUnwatchListing Send request to stop watching a listing ID that is currently in a user's Watching section of My eBid.

SaveWatchListing This method will save a listing ID to the Watching section of a users "My eBid" area.

SEARCH & BROWSE Methods eBid API methods relating to the searching of and categorization of listings within the eBid ecosystem.

GetCategoryInfo This function return single category information. If category ID is wrong then it will return error.

GetCategoryList This function return all categories below root category or any subcategory . If CategoryID set to 0 then all root categories will return , if category is not zero then all subcategories of this category will return . 'NoAdult' option force return non-adult categories only.

GetCategoryPath This function return one or few categories that allow to output category navigation like category -> subcategory1 -> subcategory2 -> subcategory3 ... CategoryID is lowest category ID in this path.

GetCategorySpecifics Get Category Item Specifics Data

SearchEbid Search live eBid listings by keywords and various other filter.

SELLING Methods eBid API methods that are related to the listing of items for sale on eBid, be it via Auction, BuyNow or Make an Offer (MaO).

GetCountryStates Returns state/counties/provinces for an eBid country site.

GetEbidSites Returns all active eBid sites around the world.

GetItemConditionValues Returns the possible values for the "Item Condition" field on the listing form. Can be used to create SELECT lists, add to keyword search forms etc.

GetListingDetailsFull This function requires a user to be logged in and returns full data on a listing, can be used to populate edit forms. It will return more information than is available to the public. eg. Reserve prices and and full shipping data for all countries.

GetListingPreview This method is similar to "SaveListingNew" but it does not put the listing live, it will check for errors and also return any eBid fees related to the listing of the item. This can be used before "SaveListingNew" to allow the user to check their listing and preview it.

GetListingPreviewEdit This method is very similar to "SaveListingEdit", but it doest not save the changed data but previews it for errors allowing user to confirm changes.

GetPaymentOptionValues Returns the possible payment options available to the user or eBid country site in question. eg. PayPal, Skrill, Checks, Postal Orders etc. Can be used to populate a form to list an item for sale.

GetShippingOptionValues Returns all the shipping options available to an eBid country site both international and domestic. Can be used to populate forms for listing items on eBid.

SaveListingClose This method will close live listings, up to 10,000 at once. If there are less than 5 ListingIDs then the will be closed immediately, if more then they will be queued for a few minutes time.

SaveListingDelete This API method will delete listings. Up to 10,000 can be deleted (not closed) immediately. Note : this will eradicate the listings and not close them into a users account history.

SaveListingEdit Save changes to a live listing.

SaveListingNew Post an item for sale on eBid. Will return the listing ID of the new item if successful.

SaveListingNewMultiple Saving up to 500 listings at time , is preferable when you need run many listings , it work faster then run single by single listings .

USER Methods eBid API methods relating to individual users/members of eBid.

GetUserAgreement Return eBid Terms & Conditions agreement that new users must agree to before registering a new account.

GetUserFeedback Returns feedback information about a user. Includes positive/neutral/negative counts and feedback text entries between "Start" and "Limit" counts.

GetUserInfo Returns user information located via "UserID" or "Username" fields, one is required. No private information is returned.

AFTER SALE LOG Methods
eBid API methods that relate to the after sale process, once a sale has been agreed. Payment, making contact, feedback etc.

GetListingASL
Returns the ASL (After Sale Log) details for a given listing. If more than one sale has been made this will return more than one ASL.

BUYING Methods
eBid API methods that enable or are related to BuyNow, Bidding and Offering (MaO).

SaveBid
This API method allows a bid to be saved on an eBid auction listing.

SaveBuyNow
This API method allows a BuyNow to be recored on alisting.

SaveCheckoutSubmit
This method takes the data submitted from "GetCheckoutData" and will return a URL to redirect to to make payment.

SaveOffer
This API method allows an offer (MaO)to be recorded on a listing the has the Make an Offer (MaO) facility switched on.

SaveOfferBuyerAcceptReject
This method is used when a buyer wishes to acceptor reject a counter offer (MaO) they have received from a seller.

SaveOfferSellerAcceptReject
This method is used when a seller wishes to accept, reject or make a counter offer on a offer (MaO) they have received.

EBID STORE Methods
eBid API methods relating to eBid Stores.

GetEbidStoreCategories
This API method returns all eBid Store categories in a given eBid Store or the subcategories below a certain hierarchy level if "ParentStoreCategoryID" is set.

GetEbidStoreCategoryList
Returns the number of eBid Stores located in a certain category. Every eBid Store is categorised based on the items it sells when creating the store.

GetEbidStores
Returns information about a single eBid Store or alternatively a list of eBid Stores owned by a single user.

SearchEbidStores
This API method will search eBid Stores according to keywords located in the title of the eBid Store.

ITEM Methods
These functions does not require login and return listings data

GetListingBids
Returns all listing bids, BuyNows and successful accepted MaO (offers). If "LoginKey" (user is logged in) field is sent in request then the response will house more information.

GetListingMultiple
Similar to "GetListingSingle" but only for live listings, but retrieves data for multiple listings in a single call. Send multiple "ListingID" instances within your request comma delimited. Will not return closed listing data.

GetListingOffers
This method returns offers (MaO) made on a listing. This will show all offers including pending, rejected, accepted, countered.

LOGIN Methods
eBid API methods to allow a user login session to be created. A Session ID is required first then a login can take place via redirecting your user to the LoginURL returned.

CheckLoginKey
Is the current "LoginKey" still valid and not expired? Eg. is the user still logged in?

GetLoginKey
This method returns a "LoginKey" based on the "SessionID" sent in the request. It's the last pasrt of the authorization process. The "LoginKey" must be stored securely at the client side and added to any relevant requests that require a login to process. It cannot be requested twice.

GetSessionID
SessionID is a 32 character random string generated by the API. A success ("ReturnURL") and failed/cancelled ("RetunCancelURL") are required to redirect after a good/bad login.

MY EBID Methods
eBid API methods relating to user account administration similar to the "My eBid" section of the eBid website.

GetMyEbidBidsMade
Returns an array of listings on which the current user has pending bids. This will not include bids that won auctions.

GetMyEbidBidsReceived
Returns and array of listings on which the user has received bids on items they are selling. Bids will be pending, eg. auction has not closed yet.

GetMyEbidBought
Returns an array of listings which have resulted in purchases by this user. Be it BuyNow, successful bids or accepted MaO (offers).

GetMyEbidCounters
Returns the most important counts relating to a user's activity. Includes number of bids made, items purchased, offers made, offers received, sold items etc. Similar to the My eBid Dashboard counts on our main site.

GetMyEbidOffersMade
Returns an array of listings on which the current user has pending offers (MaO). This will not include offers that were accepted by the seller and changed into purchased items.

GetMyEbidOffersReceived
Returns an array of listings on which the current user has pending offers (MaO) received. This will not include offers that were accepted by this user and therefore changed into sold items.

GetMyEbidSold
Returns an array of listings which have resulted in sales by this user. Be it BuyNow, successful bids or accepted MaO (offers).

GetMyEbidWatched
Returns an array of listings which the user in session is Watching.

GetUserDefaults
Returns the data as seen in the My Defaults > My Selling Defaults section of My eBid on our main website. These are saved listing details, eg. title and price that are used to populate the listing form when putting an item up for sale.

SaveQuestionNew
Allows a user to ask a question relating to a live listing, or reply to a question already asked.

SaveUnwatchListing
Send request to stop watching a listing ID that is currently in a user's Watching section of My eBid.

SaveWatchListing
This method will save a listing ID to the Watching section of a users "My eBid" area.

SEARCH & BROWSE Methods
eBid API methods relating to the searching of and categorization of listings within the eBid ecosystem.

GetCategoryInfo
This function return single category information. If category ID is wrong then it will return error.

GetCategoryList
This function return all categories below root category or any subcategory . If CategoryID set to 0 then all root categories will return , if category is not zero then all subcategories of this category will return . 'NoAdult' option force return non-adult categories only.

GetCategoryPath
This function return one or few categories that allow to output category navigation like category -> subcategory1 -> subcategory2 -> subcategory3 ... CategoryID is lowest category ID in this path.

GetCategorySpecifics
Get Category Item Specifics Data

SearchEbid
Search live eBid listings by keywords and various other filter.

SELLING Methods
eBid API methods that are related to the listing of items for sale on eBid, be it via Auction, BuyNow or Make an Offer (MaO).

GetCountryStates
Returns state/counties/provinces for an eBid country site.

GetEbidSites
Returns all active eBid sites around the world.

GetItemConditionValues
Returns the possible values for the "Item Condition" field on the listing form. Can be used to create SELECT lists, add to keyword search forms etc.

GetListingDetailsFull
This function requires a user to be logged in and returns full data on a listing, can be used to populate edit forms. It will return more information than is available to the public. eg. Reserve prices and and full shipping data for all countries.

GetListingPreview
This method is similar to "SaveListingNew" but it does not put the listing live, it will check for errors and also return any eBid fees related to the listing of the item. This can be used before "SaveListingNew" to allow the user to check their listing and preview it.

GetListingPreviewEdit
This method is very similar to "SaveListingEdit", but it doest not save the changed data but previews it for errors allowing user to confirm changes.

GetPaymentOptionValues
Returns the possible payment options available to the user or eBid country site in question. eg. PayPal, Skrill, Checks, Postal Orders etc. Can be used to populate a form to list an item for sale.

GetShippingOptionValues
Returns all the shipping options available to an eBid country site both international and domestic. Can be used to populate forms for listing items on eBid.

SaveListingClose
This method will close live listings, up to 10,000 at once. If there are less than 5 ListingIDs then the will be closed immediately, if more then they will be queued for a few minutes time.

SaveListingDelete
This API method will delete listings. Up to 10,000 can be deleted (not closed) immediately. Note : this will eradicate the listings and not close them into a users account history.

SaveListingEdit
Save changes to a live listing.

SaveListingNew
Post an item for sale on eBid. Will return the listing ID of the new item if successful.

SaveListingNewMultiple
Saving up to 500 listings at time , is preferable when you need run many listings , it work faster then run single by single listings .

USER Methods
eBid API methods relating to individual users/members of eBid.

GetUserAgreement
Return eBid Terms & Conditions agreement that new users must agree to before registering a new account.

GetUserFeedback
Returns feedback information about a user. Includes positive/neutral/negative counts and feedback text entries between "Start" and "Limit" counts.

GetUserInfo
Returns user information located via "UserID" or "Username" fields, one is required. No private information is returned.