Listing Retrieval
Partners are able to retrieve listing details via the API to surface more information within their sites, get updates on transit status, view carrier contact information post-booking and more.
To retrieve this information, use the GET v2/listings/{id} endpoint in your supplied Postman collection, with the {id} value replaced by the listing ID of your shipment. This requires your password-based OAuth Bearer token as a header value.
Leveraging the Fields function
Users can leverage the fields parameter to retrieve only the desired fields (rather than the full list below); this will result in a more efficient and performant experience for obtaining a subset of fields. For example, for a user looking to only retrieve the transit status and reference numbers, the call would be GET v2/listings/{id}?fields=transitStatus,referenceNumbers
Fields available in the response body:
acceptedBidPrice
accessorials
activatedOn
activeBidsPlaced
amountDueToServiceProvider
amountToMe
archivedOn
assignedDriver
attributes
auctionMaxPrice
auctionTargetPrice
autoAcceptPrice
availableTransitStatuses
billOfLadingNumber
bookedOn
bookingDeposit
cancellationLink
cancellationStatus
cancelledOn
checksum
commodity
commodityType
completedOn
createdOn
description
expiresOn
gallery
hasPendingBookingRequest
imageUrl
importSource
isAuction
isBrokered
isCharitable
isDefaultImage
isDutchAuction
isExclusiveListing
isItineraryMandatory
isProofOfDeliveryRequired
isReadyForPickup
isWatched
items
lastUpdatedOn
links
lister
listingId
lowestBidPrice
minimumBidAmount
namedPrice
nextTransitStatus
offerPrice
parentCommodity
parentCommodityType
paymentStatus
previousTransitStatus
priceDetails
privateNetwork
questionsAsked
quoteRequestId
route
serviceProvider
serviceTypes
status
thirdParty
title
topLevelCommodity
topLevelCommodityType
totalBidsPlaced
totalCost
totalWeightInGrams
transitStatus
uShipPayments