1.Registration API

Registration is done through auction software’s authentication service. Since payment gateways are involved, we support only HTTPS. We authenticate with basic authentication and cookie sessions. Only after registering, the user will have access to post product, admin panel(if super admin) and other segments.

The registration API brings the following formidable features

  • Registration as buyer and seller.
  • Email verification to register.
  • User Login.
  • Login with facebook.
  • Retrieve forgotten password.

2.Product Posting API

Posting a product involves a complex set of wrapper JSON which is customized and delivered based on the requirement of the customer. We have base set of required fields which are added and removed based on the specifications.

3.Search Filters API

Search filters allow multiple filtering of products, which includes sorting by the status (buy now, auction and classified). Category based sorting, time based sorting, region based sorting, price range based sorting and other filters option (enables searching options like filter by self pickup).

4.Bidding API

Bidding API allows the users to bid and the only requirement is the bid amount. Server side validations allow the users to bid the correct amount, and proxy bidding allows absentee bidding. Until the reserve price is met and auction closes, the bidding continues. Proxy bidding, if enabled, allows the user to place bid (system places the bid) whenever a bid is placed in his absence. Only requirement sent via this request is the bid_amount.

5.Dashboard API
There are two dashboards, buyer and the seller dashboards.

The following API calls are made:

Buyer Dashboard

GET /dashboard/activebids – All the bids made and the products that are active and open to bidding ( yet to be won) are listed under the active bids section of the dashboard.

  • GET /dashboard/mywon – Products that are won through bidding are listed in the won bids section of the dashboard.
  • GET /dashboard/buynow – Products that are bought by the buyer are listed in the buy now section of the dashboard.
  • GET /dashboard/mybids – Products that are bought are bidded by the buyer and not won are listed under the “mybids” section of the dashboard.
  • GET /dashboard/classified – Products that are classified and watched by the buyer are listed under the classified section of the dashboard.

Seller Dashboard

  • GET /dashboard/myselling – Active products that are being sold are listed in the seller dashboard my selling section
  • GET /dashboard/mysold – Products that the seller has sold, are listed under the my sold section of the dashboard.
  • GET /dashboard/myclosed – Products that the seller has sold/closed, are listed under the closed/time ended section of the dashboard.
  • GET /dashboard/sellerclassified – Classified posts of the seller are listed under the seller classified section of the dashboard.

6.Payments API

RESTFUL payment APIs are done through various payment gateways. Our payment gateway services include paypal, paypal-adaptive, Braintree, vougepay, stripe, payUbiz, PayUMoney, authorize and so on. We extend our services through wrapper that wraps the amount to be paid as JSON response, sends it as HTTPS request to the server to complete the transaction.

7.Shipping API

Product shipping can be done through the shipping API, which allows to track the location, time and the current place of the package. Shipping partner depends on the client’s need and is accordingly customized. Generally shipping API needs address width and height of the products.

8.Reviews API

The review API follows CRUD to add and remove reviews for the seller or product or both, depending on the requirement. Review API has got definitive schema that allows getting the rating, feedback and shows them in the related window.

9.Memberships API

Membership, subscriptions and charges can be customized accordingly as per the need of the client. Memberships and roles can be added and reverted. Control will be given to the admin panel. CRUD based.

10.Admin API
Admin control panel has various accesses, which includes

  1. Posting from admin panel
  2. Revoking and adding memberships
  3. User activation and deactivation
  4. Shipping and payment API customization
  5. Dashboard access
  6. Review customization
  7. And various other accesses.

To get access to the admin panel you should have the admin user access, which is not available for all users by default.

API Methods

All endpoints are invoked with https://www.auctionsoftwaremarketplace.com/

The reporting API endpoints are divided into two categories:

JSON endpoints and CSV export endpoints.

JSON endpoints get response and posts to the API, which in turn processes the object and gets the response from the server. For example, the API catches the search parameters as JSON and posts it to the server to fetch data from the server.

CSV export endpoints are designed for use by custom reports. These endpoints return data in CSV format with a header to describe the schema. For instance, at any point the admin user can import all the users as CSV.

Currency conversions

All cost and revenue numbers are returned with two decimal places of precision. The default currency is US Dollars (USD), and can be overridden with the currency query parameter where appropriate.

Attributions

An attribution is a customer-defined conversion event with its attributed impression(s) or click(s). There are two classes of attributions:

  1. Standard attributions are generated to be either click-through or view-through attributions. This determination is done by using the advertiser’s click-through and view-through windows, which are specified in the advertiser’s account settings.
  2. Flexible attributions behave more like potential attributions. These attributions do not have any concrete meaning without specifying click-through and view-through windows post-generation of the attribution.

There are correspondingly two sets of endpoints for attribution reporting: one for standard attributions, and one for flexible attributions. The endpoints for standard attributions provide summarized counts for click-through and view-throughs. The endpoints for flexible attributions provide more raw-level data for impression and click history, so as to allow the client to efficiently explore the resulting data set without having to make a series of calls.

1.Registration Attributions

POST /register/save

Request:

Request URL: https://auctionsoftwaremarketplace.com/register/save

Request Method:POST

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.


{
"user": {
"name": username,
"password": ********,
"city": Dallas,
"contact": 0000000000,
"email": demo@auctionsoftware.com,
"Date": Thu, 19 Jan 2017 06:27:33 GMT
}
}

2.Posting a product attributions

POST /product/save

Request:

Request URL: https://auctionsoftwaremarketplace.com/product/save

Request Method:POST

Data required:
All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"product": {
"title": Demo product,
"product_description": This is a product created for demo purposes,
"start_date": Thu, 19 Jan 2017 06:27:33 GMT,
"end_date": Thu, 25 Jan 2017 06:27:33 GMT,
"category": Gadgets,
"subcategory": mobile,
"thirdcategory": iphone,
"keywords": "keywords, reference words",
"start_price": $70.00,
"reserve_price": $100.00,
"buynow_price": $170.00,
"payment_type": COD,
"shipping_company": Self-Collect,
"image": dmo-image.jpg,
}
}

3.Search Filters API attributions

GET /product/searchfilters

Request:

Request URL: https://auctionsoftwaremarketplace.com/product/searchfilters

Request Method:GET

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"search": [
{
"search_term": buynow,
"search_name": status,
},
{
"search_term": Gadgets,
"search_name": categories,
},
{
"search_term": Dallas,
"search_name": region,
},
{
"search_term": endingsoon,
"search_name": Time,
},
{
"search_term": $70.00,
"search_name": price-max,
},
{
"search_term": $90.00,
"search_name": price-min,
}

4.Bidding API attributions

POST /product/confirm

Request:

Request URL: https://auctionsoftwaremarketplace.com/product/confirm

Request Method:POST

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"bidding": [{
"amount": $50.00
}]
}

5.Dashboard API attributions

Buyer Dashboard

  1. GET /dashboard/activebids

Request:

Request URL: https://auctionsoftwaremarketplace.com/dashboard/activebids

Request Method:GET

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"dashboard": [{
"action": bidactive
}]
}

GET /dashboard/mywon

Request:

Request URL: https://auctionsoftwaremarketplace.com/dashboard/mywon

Request Method:GET

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"dashboard": [{
"action": bidwon
}]
}

GET /dashboard/buynow
Request:

Request URL: https://auctionsoftwaremarketplace.com/dashboard/buynow

Request Method:GET

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"dashboard": [{
"action": buynow
}]
}

GET /dashboard/mybids

Request:

Request URL: https://auctionsoftwaremarketplace.com/dashboard/mybids

Request Method:GET

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"dashboard": [{
"action": mybids
}]
}

GET /dashboard/classified

Request:

Request URL: https://auctionsoftwaremarketplace.com/dashboard/classified

Request Method:GET

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"dashboard": [{
"action": classified
}]
}

Seller Dashboard

  • GET /dashboard/myselling

Request:

Request URL: https://auctionsoftwaremarketplace.com/dashboard/myselling

Request Method:GET

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"dashboard": [{
"action": myselling
}]
}

  • GET /dashboard/mysold

Request:

Request URL: https://auctionsoftwaremarketplace.com/dashboard/mysold

Request Method:GET

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"dashboard": [{
"action": mysold
}]
}

  • GET /dashboard/myclosed

Request:

Request URL: https://auctionsoftwaremarketplace.com/dashboard/myclosed

Request Method:GET

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"dashboard": [{
"action": mycolsed
}]
}

  • GET /dashboard/sellerclassified

Request:

Request URL: https://auctionsoftwaremarketplace.com/dashboard/sellerclassified

Request Method:GET

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"dashboard": [{
"action": sellerclassified
}]
}

6.Payment API attributions

GET /checkout/pay/payment-gateway

Request:

Request URL: https://auctionsoftwaremarketplace.com/checkout/pay/payment-gateway

Request Method:GET

Note: payment-gateway is the payment gateway that has been chosen by the client and integrated.

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.


{
"pay": [{
"amount": totalamount
}]
}

7.Shipping API attributions

POST /product/shippinginfo

Request:

Request URL: https://auctionsoftwaremarketplace.com/product/shippinginfo

Request Method:POST

Note: Shipping partner depends on the client requirement.

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"shipping": [
"address" : {
"name": name,
"shipping_address": shipping address,
"shipping_pincode": pincode,
"shipping_contact": contact,
"shipping_alternate_address": alternate_address,

},
“attributes”: {
“width”: width,
“height”: height,
“weight”: weight,
“distance”: distance
}
]
}

8.Review API attributions

POST /product/feedbackinfo

Request:

Request URL: https://auctionsoftwaremarketplace.com/product/feedbackinfo

Request Method:POST

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"feedback": [
"rating" : {
"Professionalism": rating,
"Service": rating,
"Item as described": rating,
"Quality": rating,
"Experience": rating,
"Delievey": rating,
},
“review”: {
"headline": headlinecontent,
"review": reviewcontent
}
]
}

9.Membership API attributions

POST /membership/package

Request:

Request URL: https://auctionsoftwaremarketplace.com/membership/package

Request Method:POST

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"package": [
"role" : {
"Buyer": buyer,
"Seller": seller
},
"membership" : {
"amount": amount,
"start_date": date
},
“customization”: {
"commission": commission,
"timeallowed": timeallowed
}
]
}

10. Admin API attributions

POST /admincp/login

Request:

Request URL: https://auctionsoftwaremarketplace.com/admincp/login

Request Method:POST

Data required:

All the fields here are given for demo purposes. The actual fields may vary, and can be customized based on the client requirement.

{
"admin": [
"access" : {
"adminuser": true
}
]
}

Reporting API Change Policy

As stated in the terms of conditions, auction software may add modifications to the API without advance notice. However, we will make commercially reasonable efforts to notify you of any changes through email and via updates to the versioning.