{"id":307910,"date":"2021-10-13T17:28:16","date_gmt":"2021-10-13T17:28:16","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=307910"},"modified":"2024-10-29T04:23:11","modified_gmt":"2024-10-29T04:23:11","slug":"product-auction-api-documentation-for-shopify","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/product-auction-api-documentation-for-shopify\/","title":{"rendered":"Auction API Documentation – Product Auction App for Shopify"},"content":{"rendered":"\n

Introducing Auction API<\/strong> for the Product Auction App<\/a><\/strong> for Shopify. <\/p>\n\n\n\n

Product Auction app helps merchants to run auctions on their stores. Then, customers visit the stores and place bids for the auction products. <\/p>\n\n\n\n

Now, the merchants using the Product Auction app <\/a>can get access to the Auction API <\/strong>via the app.<\/p>\n\n\n\n

API<\/strong> stands for an Application programming interface. It is a set of tools and protocols that will help you building sync and much more.<\/p>\n\n\n\n

Now, the Auction API Documentation includes POST & GET API methods.<\/p>\n\n\n\n

POST Method <\/strong>of the API is where developers can interface with other APIs or systems to get the desired outcome. Moreover, it is more often utilized to create new resources.<\/p>\n\n\n\n

Additionally, the GET Method<\/strong> of API is to read or retrieve a representation of a resource or information.<\/p>\n\n\n\n

Let’s understand this in detail.<\/p>\n\n\n\n

\"Auction<\/figure>\n\n\n\n

Then, get the base URL.<\/p>\n\n\n\n

Base URL: sp-auction.webkul.com\/product-auction-api <\/a><\/strong><\/p>\n\n\n\n

\n

Use Of Auction API<\/h3>\n<\/div><\/div>\n\n\n\n

Firstly, you need to understand exactly what actions you perform via the given APIs. Auction API lets you do the following functions:<\/p>\n\n\n\n

For TOKEN:-<\/h2>\n\n\n\n

POST<\/strong>\/api\/user\/refresh<\/span>
-Create an access token using the refresh token.<\/p>\n\n\n\n

NOTE<\/strong>:- POST requests are used to send data to the API server to create or update a resource. Also, the GET method is used to retrieve data from a server at the specified resource.<\/p>\n\n\n\n

Then, proceed to check Auction API methods.<\/p>\n\n\n\n

For AUCTION:-<\/h2>\n\n\n\n

POST<\/strong>\/api\/start\/{auctionId}.json<\/span>
-Start auction by auction ID<\/p>\n\n\n\n

POST<\/strong>\/api\/stop\/{auctionId}.json
<\/span>-Stop auction by auction ID<\/p>\n\n\n\n

Also, GET<\/strong>\/api\/auctions.json
<\/span>-Get Auctions by Shop<\/p>\n\n\n\n

POST<\/strong>\/api\/auctions.json <\/span>
-Add Auction<\/p>\n\n\n\n

GET<\/strong>\/api\/auctions\/{id}.json<\/span>
-Get Auctions by ID<\/p>\n\n\n\n

Also,
GET<\/strong>\/api\/shop\/auctions.json<\/span>
-Get Auctions<\/p>\n\n\n\n

and GET<\/strong>\/api\/shop\/auction\/{type}.json<\/span>
-Get Products on Auction<\/p>\n\n\n\n


also, GET<\/strong>\/api\/shop\/auctions\/running_bids_auction\/{customerId}.json<\/span>
-Get Running Bid Auctions<\/p>\n\n\n\n

and GET<\/strong>\/api\/shop\/auctions\/loss_auction\/{customerId}.json<\/span>
-Get Lossing Auctions<\/p>\n\n\n\n

also, GET<\/strong>\/api\/shop\/auctions\/winning_auction\/{customerId}.json<\/span>
-Get Winning Auctions<\/p>\n\n\n\n

Also, GET<\/strong>\/api\/shop\/auction\/{auctionId}\/start_bid.json<\/span>
-Get Start Bid of Auctions<\/p>\n\n\n\n

Then, comes the Bid API methods.<\/p>\n\n\n\n

For BID:-<\/h2>\n\n\n\n

GET<\/strong>\/api\/shop\/auction\/bidding_list\/{auctionId}.json<\/span>
-Get Bidding List<\/p>\n\n\n\n

POST<\/strong>\/api\/bids.json<\/span>
-Place Bid<\/p>\n\n\n\n

also, GET<\/strong>\/api\/shop\/auction\/{auctionId}\/bid\/{bidId}.json<\/span>
-Get Bid Information<\/p>\n\n\n\n

Then, comes the Configuration API methods.<\/p>\n\n\n\n

For CONFIGURATION:-<\/h2>\n\n\n\n

GET<\/strong>\/api\/auction\/configuration.json<\/span>
-Get Configuration by the shop<\/p>\n\n\n\n

Then, proceed to check the token properties.<\/p>\n\n\n\n

Token Properties<\/h2>\n\n\n\n

access_token<\/strong>: This is the access token from product auction API credentials.<\/p>\n\n\n\n

Then, refresh_token<\/strong>: This is the refresh token from product auction API credentials.<\/p>\n\n\n\n

<\/p>\n\n\n\n

Auction Properties<\/h2>\n\n\n\n

auction_id<\/strong>: This is the auction ID, that\u2019s used as a unique identifier for the auction.<\/p>\n\n\n\n

Then, check start & stop auction API properties.<\/p>\n\n\n\n

start_now<\/strong>: This is to start an auction immediately after creating using the auction ID.<\/p>\n\n\n\n

also, stop_now<\/strong>: This is to stop an auction immediately using the auction ID.<\/p>\n\n\n\n

Then, check the start & end auction API properties.<\/p>\n\n\n\n

start_date<\/strong>: This is the start date of the auction in UTC.<\/p>\n\n\n\n

also, end_date<\/strong>: This is the end date of the auction in UTC.<\/p>\n\n\n\n

by_seller<\/strong>: 1 if the auction is created by seller else 0.<\/p>\n\n\n\n

Then, check the properties for auction start & reserve prices.<\/p>\n\n\n\n

start_price: <\/strong>This is the starting price of the auction, the price from where the bidding will start.<\/p>\n\n\n\n

then, comes the target auction bidding price.<\/p>\n\n\n\n

reserve_price<\/strong>: This is the reserve price for the auction. Also, the target auction bidding price where the product bidding should be reached.<\/p>\n\n\n\n

Then, use the bid rule in JSON format.<\/p>\n\n\n\n

bid_rule<\/strong>: This is used for bid rule in JSON format.<\/p>\n\n\n\n

Then, check the proxy bidding.<\/p>\n\n\n\n

proxy_bidding_on<\/strong>: It allows customers to make bids automatically on auction products.<\/p>\n\n\n\n

also, popcorn_bidding<\/strong>: Dynamic bidding.<\/p>\n\n\n\n

Popcorn Bidding, also known as Dynamic Bidding, is a way of giving the bidders who were outbid an opportunity to rebid. Know More<\/a><\/strong><\/p>\n\n\n\n

More…<\/h2>\n\n\n\n

Then, comes the Popcorn bidding cases:<\/p>\n\n\n\n

extend_deadline_by<\/strong>: Minutes by which the auction deadline should be extended in case of popcorn bidding.<\/p>\n\n\n\n

extend_deadline_within<\/strong>: Minutes within which the deadline should be extended before ending the auction in case of popcorn bidding.<\/p>\n\n\n\n

Also, check the maximum popcorn bidding properties.<\/p>\n\n\n\n

max_popcorn_bid<\/strong>: Maximum number of popcorn bidding allowed.<\/p>\n\n\n\n

then, check the Booking Amount properties.<\/p>\n\n\n\n

booking_amount<\/strong>: Configure the booking amount for the auction if the configuration is enabled.<\/p>\n\n\n\n

Then, check the Joining Fee Properties.<\/p>\n\n\n\n

joining_amount<\/strong>: It is the joining amount. The customer has to pay while joining the auctions. <\/p>\n\n\n\n

About Joining Fee<\/h4>\n\n\n\n

Whenever a bidder wants to bid on the auction product, he\/she first needs to pay the auction joining fee set by the admin. <\/p>\n\n\n\n

So, this is the case when you want to charge a joining fee from customers before placing a bid.<\/p>\n\n\n\n

Moreover, it will work only if the configuration is enabled.<\/p>\n\n\n\n

buy_now_price<\/strong>: It is used to set the buy now price. Also, it will work only if the configuration is enabled.<\/p>\n\n\n\n

joining_fee_enable<\/strong>: It is used to enable the joining fee for the auction. Also, it will work only if the configuration is enabled.<\/p>\n\n\n\n

display_auction_days<\/strong>: It is used to set display auction days in terms of days.<\/p>\n\n\n\n

Then, comes the autopay feature.<\/p>\n\n\n\n

Additionally, the app allows Braintree payment gateway along with autopay functionality for your bid winner. <\/p>\n\n\n\n

auto_pay_enable<\/strong>: It is used to enable or disable autopay for the auction. <\/p>\n\n\n\n

NOTE:-<\/h4>\n\n\n\n

It will work only if the configuration for the same is enabled in configurations.<\/p>\n\n\n\n

sort_by<\/strong>: Determines the parameter by which the auctions are sorted in the response. <\/p>\n\n\n\n

Here, the available parameters are id, product_name, start_date, end_date. <\/p>\n\n\n\n

sort_order<\/strong>: Determines the sorting order. <\/p>\n\n\n\n

Then, let’s proceed to check the Bid Properties.<\/p>\n\n\n\n

Bid Properties<\/h2>\n\n\n\n

sort_by<\/strong>: Determines the parameter by which the bids are sorted in the response. <\/p>\n\n\n\n

Then, check the available parameters.<\/p>\n\n\n\n

Available parameters: <\/p>\n\n\n\n