Pricing

There are a few pricing options available to shipping customers.  Below is a list of options, both active and booked.

 

Auction

Field Type Description
isAuction
Boolean
  • true - A Service Provider can place a bid on the listing if the listing is active and available.
  • false - The listing is not tied to an auction. This field will not appear in the response body.
isDutchAuction
Boolean Only available for certain commodities. uShip Internal. Will not return with isAuction.
  • true - The listing is tied to a dutch auction.
  • false - The listing is not tied to a dutch auction.

 

Auction with Minimum Bid

Field Type Description Sample Values
minimumBidAmount
Container Wrapper for the fields describing the lowest threshold of the bid amount. -
value
Decimal A bid will not be accepted beneath this price. 19.99
label
String The localized string for the minimum bid amount. Example: "₹627.25"
"$19.99"
shortLabel
String The localized string for the minimum bid amount optimized for a mobile or touch device screen. "$20"

 

Accepted Auction

Field Type Description Sample Values
acceptedBidPrice
Container Wrapper for the fields describing the bid price the Shipping Customer accepted on the listing. -
value
Decimal The amount of the accepted bid price. 590.05
label
String The localized string for the accepted bid price amount.

"$590.05"

shortLabel
String The localized string for the accepted bid price optimized for a mobile or touch device screen. "$591"

 

Auction with Maximum Price

Field Type Description Sample Values
auctionMaxPrice
Container Wrapper for the fields describing the highest auction price. -
value
Decimal The amount of the highest auction price. 4000
label
String The localized string for the highest auction price amount. "$4,000"
shortLabel
String The localized string for the highest auction price optimized for a mobile or touch device screen. "$4,000"

 

Auction Target Price

Field Type Description Sample Values
auctionTargetPrice
Container Wrapper for the the fields describing the Shipper’s desired optimal price where they want to accept an auction bid. -
value
Decimal The amount of the desired price. 500
label
String The localized string for the Shipper's target bid price amount. "$500"
shortLabel
String The localized string for the Shipping Customer's target auction price optimized for a mobile or touch device screen. "$500"

 

Auction Auto Accept Price

Field Type Description Sample Values
autoAcceptPrice
Container Wrapper for the fields describing the automatically accepted bid price on this listing.
  • If this field is present in the returned body, indicates the listing is a brokered listing with a Book It Now bid price.
  • If absent, the listing is not a Book It Now bid price.
-
value
Decimal The automatically accepted Book It Now bid price.

900

label
String The localized string for the automatically accepted bid price. "$900.00"
shortLabel
String The localized string for the offer automatically accepted bid price optimized for a mobile or touch device screen. "$900.00"

 

Offer Price 

Field Type Description Sample Values
offerPrice / namedPrice
Container

Wrapper for the fields describing the offer price accepted on the listing.

The offer price occurs when the listing has a set price and only bids at that price are accepted or rejected. When a bid is received, the listing is given an "on-hold" status (not visible or bookable on uShip).

This status gives the shipping customer the opportunity to accept or decline the Service Provider's bid and enter in their payment information to confirm.

-
value
Decimal The offer price. 900
label
String The localized string for the offer price. "$900"
shortLabel
String The localized string for the offer price optimized for a mobile or touch device screen. "$900"