En ligne  

/v1/bid/

Manages all bid related functions
GET

/v1/bid/get_feedback_suggestions

#
Get up to five of the acting concierge's previously submitted custom feedback responses.

Paramètres

NomTypeObligatoireValeur par défautDescription
search string Non "" optional literal text to match.
Exemple de requête (cURL)
curl --get \
  'https://fr.appointmenttrader.com/v1/bid/get_feedback_suggestions' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'search={{search}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_get_feedback_suggestions_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payloadarray Oui
$.oneOf[0].allOf[1].Payload[]object Non
$.oneOf[0].allOf[1].Payload[].textstring Oui
$.oneOf[0].allOf[1].Payload[].lastUsedstring Oui
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/get_feedback_suggestions",
    "RequestUserAlias": "example-user",
    "Payload": []
}
Documentation du point de terminaison lisible par machine
GET

/v1/bid/get_list

#
Returns available bids without a publication delay, subject to access restrictions.

Paramètres

NomTypeObligatoireValeur par défautDescription
creatorUserAlias string Non "" Alias of user who created the bids, if empty all bids will be returned
locationAlias string Non "" locationAlias if this item is a bid. Slug found after the slash when opening a location in the portal
pageSize int Non 5000 Defines how many results will be return per request
pageNumber int Non 0 Defines which page should be returned
Exemple de requête (cURL)
curl --get \
  'https://fr.appointmenttrader.com/v1/bid/get_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'creatorUserAlias={{creatorUserAlias}}' \
  --data-urlencode 'locationAlias={{locationAlias}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_get_list_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payloadobject Oui
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Oui
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.Name = "All Active Bids" Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.NumberBidsinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.VolumeActiveBidsnumber Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.Descriptionstring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidIDDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidID.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidID.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidUUIDstring | null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidCreatedDatestring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidAmountDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidAmount.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidAmount.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isPremiumDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isPremium.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isPremium.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationName Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationName.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationName.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].communityBidDiscussionLink Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].communityBidDiscussionLink.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].communityBidDiscussionLink.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidStartTimestring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidEndTimestring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidCreatorUserAlias Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidCreatorUserAlias.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidCreatorUserAlias.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].heldByUserAlias Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].heldByUserAlias.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].heldByUserAlias.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].customSearchRequestString Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].customSearchRequestString.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].customSearchRequestString.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatusobject Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.statusstring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.labelstring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.messagestring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.sponsorAliasstring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.sponsorChatLinkstring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.sponsorStatusstring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.moveOwnershipUnavailableReasonstring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.moveOwnershipUnavailableMessagestring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canPickupboolean Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canDropboolean Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canFillboolean Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canMoveOwnershipboolean Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canShortlistboolean Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canDiscussboolean Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canChatboolean Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.requiresSponsorboolean Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canFillDirectlyboolean Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.fillRateBasisPointsinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.minimumFillRateBasisPointsinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.missingHoldPermissionsarray Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.missingHoldPermissions[]string Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.directFillNoticeboolean Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.directFillAvailabilitystring ["available","unavailable","selection_pending","seller_ineligible"] Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auctionURLstring Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auctionobject Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.venuestring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.startTimestring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.endTimestring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.bidIDinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.bidAmountCentsinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.roundID Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.roundID.anyOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.roundID.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.statestring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.serverTimeinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.enabledboolean Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.openingCentsinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.incrementCentsinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.leadingCentsinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.nextCentsinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.estimatedFeesCentsinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.remainingCentsinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.leadingboolean Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.priorityUntilnull Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.priorityMine = false Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffersarray Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[]object Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[].idinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[].amountCentsinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[].statestring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[].refundCentsinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.eligibilityError Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.eligibilityError.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.eligibilityError.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.buyerIdentityHiddenboolean NonTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.buyerIdentityHiddenUntilinteger | null NonLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.poolRequiredboolean Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0]object Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0].roundIDinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0].statestring ["collecting","immediate"] Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0].closesAtinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0].serverTimeinteger Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[1]null Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAddress Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAddress.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAddress.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].buyerIdentityHiddenboolean NonTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].buyerIdentityHiddenUntilinteger | null NonLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string Non
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/get_list",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "All Active Bids",
            "MetaInformation": {
                "NumberBids": 0,
                "VolumeActiveBids": 0,
                "Description": "synthetic-example"
            },
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}
Documentation du point de terminaison lisible par machine
GET

/v1/bid/get_pickup_requirements

#
Returns the seller pickup state and confirmation data for one bid.

Paramètres

NomTypeObligatoireValeur par défautDescription
bidID int Oui — numeric bid ID
Exemple de requête (cURL)
curl --get \
  'https://fr.appointmenttrader.com/v1/bid/get_pickup_requirements' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_get_pickup_requirements_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payloadobject Oui
$.oneOf[0].allOf[1].Payload.bidobject Oui
$.oneOf[0].allOf[1].Payload.bid.requestModestring ["general","specific"] Oui
$.oneOf[0].allOf[1].Payload.bid.operationalExpiry Oui
$.oneOf[0].allOf[1].Payload.bid.operationalExpiry.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.bid.operationalExpiry.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptionsarray Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[]object Non
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].ATLocation_IDinteger Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].ATLocationInventoryType_IDinteger Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].TimeRangeUnitCountinteger Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].Quantityinteger Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].LocationNamestring Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].LocationAliasstring Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].InventoryTypeNamestring Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].StartDatestring Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].EndDatestring Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].StartTimestring Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].EndTimestring Oui
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].PartySize Non
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].PartySize.anyOf[0]integer Non
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].PartySize.anyOf[1]null Non
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].CheckOutDate Non
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].CheckOutDate.anyOf[0]string Non
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].CheckOutDate.anyOf[1]null Non
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].Constraintsarray Non
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].Constraints[]string Non
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].ExcludedVenuesarray Non
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].ExcludedVenues[]string Non
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].OperationalProjectionboolean NonTrue for a general request’s operational concierge anchor; these dates/location are not resolved fulfillment facts.
$.oneOf[0].allOf[1].Payload.bid.deliverableTypestring ["fulfillment","research"] Oui
$.oneOf[0].allOf[1].Payload.bid.researchScope Oui
$.oneOf[0].allOf[1].Payload.bid.researchScope.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.bid.researchScope.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.bid.bidIDinteger Oui
$.oneOf[0].allOf[1].Payload.bid.amountinteger Oui
$.oneOf[0].allOf[1].Payload.bid.buyerUserIDinteger | null Oui
$.oneOf[0].allOf[1].Payload.bid.appointmentIDinteger Oui
$.oneOf[0].allOf[1].Payload.bid.discussionPostIDinteger Oui
$.oneOf[0].allOf[1].Payload.bid.bidUUIDstring Oui
$.oneOf[0].allOf[1].Payload.bid.createdDatestring Oui
$.oneOf[0].allOf[1].Payload.bid.currentHolderLastUpdateDatestring Oui
$.oneOf[0].allOf[1].Payload.bid.amountFormattedstring Oui
$.oneOf[0].allOf[1].Payload.bid.directHireTargetLabelstring Oui
$.oneOf[0].allOf[1].Payload.bid.locationAliasstring Oui
$.oneOf[0].allOf[1].Payload.bid.locationNamestring Oui
$.oneOf[0].allOf[1].Payload.bid.locationAddressstring Oui
$.oneOf[0].allOf[1].Payload.bid.inventoryTypeNamestring Oui
$.oneOf[0].allOf[1].Payload.bid.customRequeststring Oui
$.oneOf[0].allOf[1].Payload.bid.startTimestring Oui
$.oneOf[0].allOf[1].Payload.bid.endTimestring Oui
$.oneOf[0].allOf[1].Payload.bid.timeLabelstring Oui
$.oneOf[0].allOf[1].Payload.bid.buyerAliasstring | null Oui
$.oneOf[0].allOf[1].Payload.bid.currentHolderAliasstring Oui
$.oneOf[0].allOf[1].Payload.bid.submissionURLstring Oui
$.oneOf[0].allOf[1].Payload.bid.appointmentUUIDstring Oui
$.oneOf[0].allOf[1].Payload.bid.appointmentStatusstring Oui
$.oneOf[0].allOf[1].Payload.bid.respondByTimestring Oui
$.oneOf[0].allOf[1].Payload.bid.respondByLabelstring Oui
$.oneOf[0].allOf[1].Payload.bid.fillURLstring Oui
$.oneOf[0].allOf[1].Payload.bid.fillListingURLstring Oui
$.oneOf[0].allOf[1].Payload.bid.discussionURLstring Oui
$.oneOf[0].allOf[1].Payload.bid.privateChatUserAliasstring | null Oui
$.oneOf[0].allOf[1].Payload.bid.privateChatNamestring | null Oui
$.oneOf[0].allOf[1].Payload.bid.notestring Oui
$.oneOf[0].allOf[1].Payload.bid.isPremiumboolean Oui
$.oneOf[0].allOf[1].Payload.bid.isShortlistedboolean Oui
$.oneOf[0].allOf[1].Payload.bid.isDirectHireboolean Oui
$.oneOf[0].allOf[1].Payload.bid.isCustomConciergeRequestboolean Oui
$.oneOf[0].allOf[1].Payload.bid.locationHasRegulationRestrictionsboolean Oui
$.oneOf[0].allOf[1].Payload.bid.submissionRejectedByReviewerboolean Oui
$.oneOf[0].allOf[1].Payload.bid.directHireTargetsarray Oui
$.oneOf[0].allOf[1].Payload.bid.directHireTargets[]object Non
$.oneOf[0].allOf[1].Payload.bid.directHireTargets[].userIDinteger Oui
$.oneOf[0].allOf[1].Payload.bid.directHireTargets[].aliasstring Oui
$.oneOf[0].allOf[1].Payload.bid.locationID Oui
$.oneOf[0].allOf[1].Payload.bid.locationID.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.bid.locationID.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.bid.locationID.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.bid.locationID.anyOf[1] = "" Oui
$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID Oui
$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID.anyOf[1] = "" Oui
$.oneOf[0].allOf[1].Payload.bid.currentHolderUserID Oui
$.oneOf[0].allOf[1].Payload.bid.currentHolderUserID.anyOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.bid.currentHolderUserID.anyOf[1] = "" Oui
$.oneOf[0].allOf[1].Payload.bid.submissionLifecyclestring ["held","changes_requested","in_review","submitted","confirmation_required","completed","closed"] Oui
$.oneOf[0].allOf[1].Payload.bid.submittedAt Oui
$.oneOf[0].allOf[1].Payload.bid.submittedAt.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.bid.submittedAt.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal Oui
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].proposalTokenstring Oui
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].chatIDinteger Oui
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].chatURLstring Oui
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].actionButtonIDinteger Oui
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].createdDatestring Oui
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].proposedLocationNamestring Oui
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].proposedTimeLabelstring Oui
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].proposedInventoryTypeNamestring Oui
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].summarystring Oui
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.bid.viewsobject Oui
$.oneOf[0].allOf[1].Payload.bid.views.24HoursDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.bid.views.24Hours.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.bid.views.24Hours.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.bid.views.AlltimeDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.bid.views.Alltime.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.bid.views.Alltime.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.bid.actionStateobject Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.statusstring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.labelstring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.messagestring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.sponsorAliasstring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.sponsorChatLinkstring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.sponsorStatusstring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.moveOwnershipUnavailableReasonstring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.moveOwnershipUnavailableMessagestring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.canPickupboolean Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.canDropboolean Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.canFillboolean Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.canMoveOwnershipboolean Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.canShortlistboolean Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.canDiscussboolean Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.canChatboolean Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.requiresSponsorboolean Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.canFillDirectlyboolean Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.fillRateBasisPointsinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.minimumFillRateBasisPointsinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.missingHoldPermissionsarray Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.missingHoldPermissions[]string Non
$.oneOf[0].allOf[1].Payload.bid.actionState.directFillNoticeboolean Non
$.oneOf[0].allOf[1].Payload.bid.actionState.directFillAvailabilitystring ["available","unavailable","selection_pending","seller_ineligible"] Non
$.oneOf[0].allOf[1].Payload.bid.actionState.auctionURLstring Non
$.oneOf[0].allOf[1].Payload.bid.actionState.auctionobject Non
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.venuestring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.startTimestring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.endTimestring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.bidIDinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.bidAmountCentsinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.roundID Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.roundID.anyOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.roundID.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.statestring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.serverTimeinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.enabledboolean Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.openingCentsinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.incrementCentsinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.leadingCentsinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.nextCentsinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.estimatedFeesCentsinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.remainingCentsinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.leadingboolean Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.priorityUntilnull Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.priorityMine = false Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffersarray Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[]object Non
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[].idinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[].amountCentsinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[].statestring Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[].refundCentsinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.eligibilityError Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.eligibilityError.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.eligibilityError.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.buyerIdentityHiddenboolean NonTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.buyerIdentityHiddenUntilinteger | null NonLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[0].allOf[1].Payload.bid.actionState.poolRequiredboolean Non
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound Non
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0]object Non
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0].roundIDinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0].statestring ["collecting","immediate"] Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0].closesAtinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0].serverTimeinteger Oui
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[1]null Non
$.oneOf[0].allOf[1].Payload.bid.buyerIdentityHiddenboolean NonTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.bid.buyerIdentityHiddenUntilinteger | null NonLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[0].allOf[1].Payload.actionStateobject Oui
$.oneOf[0].allOf[1].Payload.actionState.statusstring Oui
$.oneOf[0].allOf[1].Payload.actionState.labelstring Oui
$.oneOf[0].allOf[1].Payload.actionState.messagestring Oui
$.oneOf[0].allOf[1].Payload.actionState.sponsorAliasstring Oui
$.oneOf[0].allOf[1].Payload.actionState.sponsorChatLinkstring Oui
$.oneOf[0].allOf[1].Payload.actionState.sponsorStatusstring Oui
$.oneOf[0].allOf[1].Payload.actionState.moveOwnershipUnavailableReasonstring Oui
$.oneOf[0].allOf[1].Payload.actionState.moveOwnershipUnavailableMessagestring Oui
$.oneOf[0].allOf[1].Payload.actionState.canPickupboolean Oui
$.oneOf[0].allOf[1].Payload.actionState.canDropboolean Oui
$.oneOf[0].allOf[1].Payload.actionState.canFillboolean Oui
$.oneOf[0].allOf[1].Payload.actionState.canMoveOwnershipboolean Oui
$.oneOf[0].allOf[1].Payload.actionState.canShortlistboolean Oui
$.oneOf[0].allOf[1].Payload.actionState.canDiscussboolean Oui
$.oneOf[0].allOf[1].Payload.actionState.canChatboolean Oui
$.oneOf[0].allOf[1].Payload.actionState.requiresSponsorboolean Oui
$.oneOf[0].allOf[1].Payload.actionState.canFillDirectlyboolean Oui
$.oneOf[0].allOf[1].Payload.actionState.fillRateBasisPointsinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.minimumFillRateBasisPointsinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.missingHoldPermissionsarray Oui
$.oneOf[0].allOf[1].Payload.actionState.missingHoldPermissions[]string Non
$.oneOf[0].allOf[1].Payload.actionState.directFillNoticeboolean Non
$.oneOf[0].allOf[1].Payload.actionState.directFillAvailabilitystring ["available","unavailable","selection_pending","seller_ineligible"] Non
$.oneOf[0].allOf[1].Payload.actionState.auctionURLstring Non
$.oneOf[0].allOf[1].Payload.actionState.auctionobject Non
$.oneOf[0].allOf[1].Payload.actionState.auction.venuestring Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.startTimestring Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.endTimestring Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.bidIDinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.bidAmountCentsinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.roundID Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.roundID.anyOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.roundID.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.statestring Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.serverTimeinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.enabledboolean Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.openingCentsinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.incrementCentsinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.leadingCentsinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.nextCentsinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.estimatedFeesCentsinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.remainingCentsinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.leadingboolean Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.priorityUntilnull Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.priorityMine = false Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffersarray Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[]object Non
$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[].idinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[].amountCentsinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[].statestring Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[].refundCentsinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.eligibilityError Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.eligibilityError.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.eligibilityError.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.actionState.auction.buyerIdentityHiddenboolean NonTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.actionState.auction.buyerIdentityHiddenUntilinteger | null NonLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[0].allOf[1].Payload.actionState.poolRequiredboolean Non
$.oneOf[0].allOf[1].Payload.actionState.responseRound Non
$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0]object Non
$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0].roundIDinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0].statestring ["collecting","immediate"] Oui
$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0].closesAtinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0].serverTimeinteger Oui
$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[1]null Non
$.oneOf[0].allOf[1].Payload.maxHoldDays Oui
$.oneOf[0].allOf[1].Payload.maxHoldDays.anyOf[0]DatabaseNumber OuiNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.maxHoldDays.anyOf[0].oneOf[0]number Oui
$.oneOf[0].allOf[1].Payload.maxHoldDays.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.maxHoldDays.anyOf[1]boolean Oui
$.oneOf[0].allOf[1].Payload.maxCurrentHolds Oui
$.oneOf[0].allOf[1].Payload.maxCurrentHolds.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.maxCurrentHolds.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.maxCurrentHolds.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.maxCurrentHolds.anyOf[1]boolean Oui
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/get_pickup_requirements",
    "RequestUserAlias": "example-user",
    "Payload": {
        "bid": {
            "requestMode": "general",
            "operationalExpiry": "synthetic-example",
            "acceptedOptions": [],
            "deliverableType": "fulfillment",
            "researchScope": "synthetic-example",
            "bidID": 0,
            "amount": 0,
            "buyerUserID": 0,
            "appointmentID": 0,
            "discussionPostID": 0,
            "bidUUID": "synthetic-example",
            "createdDate": "synthetic-example",
            "currentHolderLastUpdateDate": "synthetic-example",
            "amountFormatted": "synthetic-example",
            "directHireTargetLabel": "synthetic-example",
            "locationAlias": "synthetic-example",
            "locationName": "synthetic-example",
            "locationAddress": "synthetic-example",
            "inventoryTypeName": "synthetic-example",
            "customRequest": "synthetic-example",
            "startTime": "synthetic-example",
            "endTime": "synthetic-example",
            "timeLabel": "synthetic-example",
            "buyerAlias": "synthetic-example",
            "currentHolderAlias": "synthetic-example",
            "submissionURL": "synthetic-example",
            "appointmentUUID": "synthetic-example",
            "appointmentStatus": "synthetic-example",
            "respondByTime": "synthetic-example",
            "respondByLabel": "synthetic-example",
            "fillURL": "synthetic-example",
            "fillListingURL": "synthetic-example",
            "discussionURL": "synthetic-example",
            "privateChatUserAlias": "synthetic-example",
            "privateChatName": "synthetic-example",
            "note": "synthetic-example",
            "isPremium": false,
            "isShortlisted": false,
            "isDirectHire": false,
            "isCustomConciergeRequest": false,
            "locationHasRegulationRestrictions": false,
            "submissionRejectedByReviewer": false,
            "directHireTargets": [],
            "locationID": 0,
            "inventoryTypeID": 0,
            "currentHolderUserID": 0,
            "submissionLifecycle": "held",
            "submittedAt": "synthetic-example",
            "pendingChangeProposal": {
                "proposalToken": "synthetic-example",
                "chatID": 0,
                "chatURL": "synthetic-example",
                "actionButtonID": 0,
                "createdDate": "synthetic-example",
                "proposedLocationName": "synthetic-example",
                "proposedTimeLabel": "synthetic-example",
                "proposedInventoryTypeName": "synthetic-example",
                "summary": "synthetic-example"
            },
            "views": {
                "24Hours": 0,
                "Alltime": 0
            },
            "actionState": {
                "status": "synthetic-example",
                "label": "synthetic-example",
                "message": "synthetic-example",
                "sponsorAlias": "synthetic-example",
                "sponsorChatLink": "synthetic-example",
                "sponsorStatus": "synthetic-example",
                "moveOwnershipUnavailableReason": "synthetic-example",
                "moveOwnershipUnavailableMessage": "synthetic-example",
                "canPickup": false,
                "canDrop": false,
                "canFill": false,
                "canMoveOwnership": false,
                "canShortlist": false,
                "canDiscuss": false,
                "canChat": false,
                "requiresSponsor": false,
                "canFillDirectly": false,
                "fillRateBasisPoints": 0,
                "minimumFillRateBasisPoints": 0,
                "missingHoldPermissions": []
            }
        },
        "actionState": {
            "status": "synthetic-example",
            "label": "synthetic-example",
            "message": "synthetic-example",
            "sponsorAlias": "synthetic-example",
            "sponsorChatLink": "synthetic-example",
            "sponsorStatus": "synthetic-example",
            "moveOwnershipUnavailableReason": "synthetic-example",
            "moveOwnershipUnavailableMessage": "synthetic-example",
            "canPickup": false,
            "canDrop": false,
            "canFill": false,
            "canMoveOwnership": false,
            "canShortlist": false,
            "canDiscuss": false,
            "canChat": false,
            "requiresSponsor": false,
            "canFillDirectly": false,
            "fillRateBasisPoints": 0,
            "minimumFillRateBasisPoints": 0,
            "missingHoldPermissions": []
        },
        "maxHoldDays": 0,
        "maxCurrentHolds": 0
    }
}
Documentation du point de terminaison lisible par machine
GET

/v1/bid/get_required_feedback

#
Returns active notified bids the acting seller is eligible to pick up at their currently followed locations. An empty array clears prior requests.
Exemple de requête (cURL)
curl --get \
  'https://fr.appointmenttrader.com/v1/bid/get_required_feedback' \
  --data-urlencode 'key={{API_KEY}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_get_required_feedback_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payloadarray Oui
$.oneOf[0].allOf[1].Payload[]object Non
$.oneOf[0].allOf[1].Payload[].ATLocation_IDDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ATLocation_ID.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload[].ATLocation_ID.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload[].FeedbackLocationNamestring Oui
$.oneOf[0].allOf[1].Payload[].ATLocation_Aliasstring Oui
$.oneOf[0].allOf[1].Payload[].ATLocation_Namestring Oui
$.oneOf[0].allOf[1].Payload[].ATBids_AmountDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ATBids_Amount.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload[].ATBids_Amount.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload[].StartTimestring Oui
$.oneOf[0].allOf[1].Payload[].EndTimestring Oui
$.oneOf[0].allOf[1].Payload[].ATLocationInventoryType_Name Oui
$.oneOf[0].allOf[1].Payload[].ATLocationInventoryType_Name.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload[].ATLocationInventoryType_Name.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload[].RequestString Oui
$.oneOf[0].allOf[1].Payload[].RequestString.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload[].RequestString.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID Oui
$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload[].BidUUIDstring | null Oui
$.oneOf[0].allOf[1].Payload[].ATBids_IDDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ATBids_ID.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload[].ATBids_ID.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload[].ATBids_IsPremiumDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ATBids_IsPremium.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload[].ATBids_IsPremium.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload[].buyerIdentityHiddenboolean NonTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload[].buyerIdentityHiddenUntilinteger | null NonLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/get_required_feedback",
    "RequestUserAlias": "example-user",
    "Payload": []
}
Documentation du point de terminaison lisible par machine
GET

/v1/bid/get_submission

#
Returns the acting submitter's private bid confirmation or immutable completed receipt.

Paramètres

NomTypeObligatoireValeur par défautDescription
bidID int Oui — Bid ID.
Exemple de requête (cURL)
curl --get \
  'https://fr.appointmenttrader.com/v1/bid/get_submission' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_get_submission_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payload Oui
$.oneOf[0].allOf[1].Payload.oneOf[0]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].mode = "detail" Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0].totalinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0].submittedinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0].urlstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0].transactionIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].appointmentIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].listingUUIDstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].accessobject Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].access.rolestring ["owner","shared","reviewer","guest","transfer-agent","submission"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].access.canViewFullboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].access.isOwnerboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].access.isSharedGuestboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].access.isReviewerboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].access.isUnlockedDetailboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].access.authorizedByShareCodeboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].access.readOnly = true Non
$.oneOf[0].allOf[1].Payload.oneOf[0].locationobject Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].location.idinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].location.namestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].location.aliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].location.addressstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].location.googleMapsURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].location.cityLinestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].location.timezonestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].location.imageURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservationobject Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.refundStatusLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.descriptorstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.inventoryNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.datestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.timestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.dateLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.timeLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.dateTimeLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.partySizeLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.checkInNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.emailstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.phonestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.detailStatementstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.purchaseSummarystring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.purchaseAmountFormattedstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.status Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.status.anyOf[0]string ["Draft","Submitted","In Review","Rejected","Private","Unlocked","Approved","Refunded","Transfer Requested","Transfer Failed","Transfer Failed But Unlocked","Standard Failed","Archived","In Transfer"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.status.anyOf[1] = "" Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.headcountinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFieldsarray Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[]object Non
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].idinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].labelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].descriptionstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].typestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].valuestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.isPastboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].peopleobject Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].people.ownerAliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].people.creatorAliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guestsReservationGuests Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[0]array Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].shareURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].headcountinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].confirmedCountinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].pendingSlotsinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].itemsarray Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[]object Non
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].kindstring ["owner","shared"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].namestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].aliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].statusstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].lastSeenLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].reviewReservationReview Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[0]array Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[1]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[1].canReview = false Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[1].isActive = false Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].revisionstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].canReview = true Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].isActive = true Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].needsBeginboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].isInProgressboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].isSelfReviewboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].reviewRewardEligibleboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].reviewRewardPointsinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].askingPriceSmallestUnitinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].reviewRewardFormattedstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].askingPriceFormattedstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].questionstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].respondByDatestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].respondByTimestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].respondByLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].legacyReviewURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[0].idinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[0].amountFormattedstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[0].discussionURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].historyarray Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[]object Non
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].createdLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].statusstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].descriptionstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].descriptionHTMLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].reviewerAliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actionsReservationActions Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].shareURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceCheckoutURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServicePriceLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceLocationNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceInventoryNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceDateLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceTimeLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reportProblemURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].refundChatURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].refundChatV2URLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].sellerChatURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].sellerChatV2URLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].absoluteShareURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addServiceAppointmentIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServicePriceSmallestUnitinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].refundChatIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].sellerChatIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addServiceAvailableboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].manageAvailableboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reportInfractionAvailableboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellAvailableboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferServiceobject Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.visibleboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestAvailableboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.cancelAvailableboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.isRequestedboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.isInTransferboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.isCompletedboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.isFailedboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.appointmentIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.typestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.statusstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.listingUUIDstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.currentNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedGivenNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedFamilyNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedByAliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedAtstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestEndpointstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.cancelEndpointstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].reviewRequestIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoardIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].boardIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetLocationIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].locationIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].appointmentIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetTypestring ["user","location"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetRolestring ["buyer","seller","location"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].idinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].boardIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].countinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].slugstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].namestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].citystring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].cityGroupCodestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].intentstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].callbackstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].unitLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].routingDescriptionstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].createsRegularBoardPostboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].isDefaultRequestBoardboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].isDefaultListingBoardboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].routingEnabledboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].selectedboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetDisplayNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].locationNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].locationAliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].titlestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].subtitlestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].promptstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].ctaLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].completedboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetUserIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetAliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetProfileURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].completedPostIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].completedPostURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].viewURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0]LocationReviewAction Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].reviewRequestIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoardIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].boardIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetLocationIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].locationIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].appointmentIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetTypestring ["user","location"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetRolestring ["buyer","seller","location"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].idinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].boardIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].countinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].slugstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].namestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].citystring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].cityGroupCodestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].intentstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].callbackstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].unitLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].routingDescriptionstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].createsRegularBoardPostboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].isDefaultRequestBoardboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].isDefaultListingBoardboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].routingEnabledboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].selectedboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetDisplayNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].locationNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].locationAliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].titlestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].subtitlestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].promptstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].ctaLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].completedboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetUserIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetAliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetProfileURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].completedPostIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].completedPostURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].viewURLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].reviewRequestIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoardIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].boardIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetLocationIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].locationIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].appointmentIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetTypestring ["user","location"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetRolestring ["buyer","seller","location"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].idinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].boardIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].countinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].slugstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].namestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].citystring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].cityGroupCodestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].intentstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].callbackstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].unitLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].routingDescriptionstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].createsRegularBoardPostboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].isDefaultRequestBoardboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].isDefaultListingBoardboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].routingEnabledboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].selectedboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetDisplayNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].locationNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].locationAliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].titlestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].subtitlestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].promptstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].ctaLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].completedboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellEndpointstring Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellListingIDstring Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellLocationNamestring Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellInventoryNamestring Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellDateLabelstring Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellTimeLabelstring Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellAppointmentIDinteger Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellCurrentPriceSmallestUnitinteger Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellMinPriceinteger Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellMaxPriceinteger Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellTransferFeeBasisPointsinteger Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellRequiresReviewboolean Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSelfReviewAvailableboolean Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellRelistOriginalboolean Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffersarray Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers[]object Non
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers[].timeLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers[].priceLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers[].inventoryTypestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[1]array Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].copyobject Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].copy.titlestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].copy.descriptionstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submissionobject Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.bidIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.appointmentIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.bidUUIDstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.listingUUIDstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.revisionstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.statusstring ["Draft","Submitted","In Review","Rejected","CONFIRMATION_REQUIRED","COMPLETED","CLOSED"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.submittedAt Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.submittedAt.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.submittedAt.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.canCorrectboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.correctionError Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.correctionError.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.correctionError.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.lifecyclestring ["held","changes_requested","in_review","submitted","confirmation_required","completed","closed"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.rejectedByReviewerboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.canSelfReviewboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.historyarray Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[]object Non
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].idinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].reviewerUserIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].createdDatestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].createdLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].statusstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].descriptionstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].descriptionTextstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].descriptionHTMLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].reviewerAliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translationobject Non
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.contextstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.endpointstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.sourceLanguageCodestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.targetLanguageCodestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.receiverLanguageCodestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.targetLanguageNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.sourceContentHashstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.titlestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.bodystring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.originalTitlestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.originalBodystring Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.reviewHistoryIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.notificationIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.statestring ["done","eligible"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.eligibleboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.cachedboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.historicalDetailsUnavailableboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.buyerIdentityHiddenboolean NonTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.buyerIdentityHiddenUntilinteger | null NonLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[0].allOf[1].Payload.oneOf[1]object Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].mode = "submission-receipt" Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].appointmentIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].listingUUIDstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].accessobject Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].access.role = "submission" Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].access.readOnly = true Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].reservationarray Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].actionsarray Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submissionobject Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.bidIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.appointmentIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.bidUUIDstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.listingUUIDstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.revisionstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.statusstring ["Draft","Submitted","In Review","Rejected","CONFIRMATION_REQUIRED","COMPLETED","CLOSED"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.submittedAt Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.submittedAt.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.submittedAt.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.canCorrectboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.correctionError Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.correctionError.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.correctionError.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.lifecyclestring ["held","changes_requested","in_review","submitted","confirmation_required","completed","closed"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.rejectedByReviewerboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.canSelfReviewboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.historyarray Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[]object Non
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].idinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].reviewerUserIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].createdDatestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].createdLabelstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].statusstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].descriptionstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].descriptionTextstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].descriptionHTMLstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].reviewerAliasstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translationobject Non
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.contextstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.endpointstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.sourceLanguageCodestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.targetLanguageCodestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.receiverLanguageCodestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.targetLanguageNamestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.sourceContentHashstring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.titlestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.bodystring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.originalTitlestring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.originalBodystring Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.reviewHistoryIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.notificationIDinteger Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.statestring ["done","eligible"] Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.eligibleboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.cachedboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.historicalDetailsUnavailableboolean Oui
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.buyerIdentityHiddenboolean NonTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.buyerIdentityHiddenUntilinteger | null NonLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/get_submission",
    "RequestUserAlias": "example-user",
    "Payload": {
        "mode": "detail",
        "customerSurveys": {
            "total": 0,
            "submitted": 0,
            "url": "synthetic-example",
            "transactionID": 0
        },
        "appointmentID": 0,
        "listingUUID": "synthetic-example",
        "access": {
            "role": "owner",
            "canViewFull": false,
            "isOwner": false,
            "isSharedGuest": false,
            "isReviewer": false,
            "isUnlockedDetail": false,
            "authorizedByShareCode": false
        },
        "location": {
            "id": 0,
            "name": "synthetic-example",
            "alias": "synthetic-example",
            "address": "synthetic-example",
            "googleMapsURL": "synthetic-example",
            "cityLine": "synthetic-example",
            "timezone": "synthetic-example",
            "imageURL": "synthetic-example"
        },
        "reservation": {
            "refundStatusLabel": "synthetic-example",
            "descriptor": "synthetic-example",
            "inventoryName": "synthetic-example",
            "date": "synthetic-example",
            "time": "synthetic-example",
            "dateLabel": "synthetic-example",
            "timeLabel": "synthetic-example",
            "dateTimeLabel": "synthetic-example",
            "partySizeLabel": "synthetic-example",
            "checkInName": "synthetic-example",
            "email": "synthetic-example",
            "phone": "synthetic-example",
            "detailStatement": "synthetic-example",
            "purchaseSummary": "synthetic-example",
            "purchaseAmountFormatted": "synthetic-example",
            "status": "Draft",
            "headcount": 0,
            "customFields": [],
            "isPast": false
        },
        "people": {
            "ownerAlias": "synthetic-example",
            "creatorAlias": "synthetic-example"
        },
        "guests": [],
        "review": [],
        "actions": {
            "shareURL": "synthetic-example",
            "addTransferServiceCheckoutURL": "synthetic-example",
            "addTransferServicePriceLabel": "synthetic-example",
            "addTransferServiceLocationName": "synthetic-example",
            "addTransferServiceInventoryName": "synthetic-example",
            "addTransferServiceDateLabel": "synthetic-example",
            "addTransferServiceTimeLabel": "synthetic-example",
            "reportProblemURL": "synthetic-example",
            "refundChatURL": "synthetic-example",
            "refundChatV2URL": "synthetic-example",
            "sellerChatURL": "synthetic-example",
            "sellerChatV2URL": "synthetic-example",
            "absoluteShareURL": "synthetic-example",
            "addServiceAppointmentID": 0,
            "addTransferServicePriceSmallestUnit": 0,
            "refundChatID": 0,
            "sellerChatID": 0,
            "addServiceAvailable": false,
            "manageAvailable": false,
            "reportInfractionAvailable": false,
            "resellAvailable": false,
            "transferService": {
                "visible": false,
                "requestAvailable": false,
                "cancelAvailable": false,
                "isRequested": false,
                "isInTransfer": false,
                "isCompleted": false,
                "isFailed": false,
                "appointmentID": 0,
                "type": "synthetic-example",
                "status": "synthetic-example",
                "listingUUID": "synthetic-example",
                "currentName": "synthetic-example",
                "requestedName": "synthetic-example",
                "requestedGivenName": "synthetic-example",
                "requestedFamilyName": "synthetic-example",
                "requestedByAlias": "synthetic-example",
                "requestedAt": "synthetic-example",
                "requestEndpoint": "synthetic-example",
                "cancelEndpoint": "synthetic-example"
            },
            "reviewRequest": {
                "reviewRequestID": 0,
                "selectedBoardID": 0,
                "boardID": 0,
                "targetID": 0,
                "targetLocationID": 0,
                "locationID": 0,
                "appointmentID": 0,
                "targetType": "user",
                "targetRole": "buyer",
                "selectedBoard": {
                    "id": 0,
                    "boardID": 0,
                    "count": 0,
                    "slug": "synthetic-example",
                    "name": "synthetic-example",
                    "city": "synthetic-example",
                    "cityGroupCode": "synthetic-example",
                    "intent": "synthetic-example",
                    "callback": "synthetic-example",
                    "unitLabel": "synthetic-example",
                    "routingDescription": "synthetic-example",
                    "createsRegularBoardPost": false,
                    "isDefaultRequestBoard": false,
                    "isDefaultListingBoard": false,
                    "routingEnabled": false,
                    "selected": false
                },
                "targetDisplayName": "synthetic-example",
                "locationName": "synthetic-example",
                "locationAlias": "synthetic-example",
                "title": "synthetic-example",
                "subtitle": "synthetic-example",
                "prompt": "synthetic-example",
                "ctaLabel": "synthetic-example",
                "completed": false,
                "targetUserID": 0,
                "targetAlias": "synthetic-example",
                "targetProfileURL": "synthetic-example",
                "completedPostID": 0,
                "completedPostURL": "synthetic-example",
                "viewURL": "synthetic-example"
            },
            "locationReview": {
                "reviewRequestID": 0,
                "selectedBoardID": 0,
                "boardID": 0,
                "targetID": 0,
                "targetLocationID": 0,
                "locationID": 0,
                "appointmentID": 0,
                "targetType": "user",
                "targetRole": "buyer",
                "selectedBoard": {
                    "id": 0,
                    "boardID": 0,
                    "count": 0,
                    "slug": "synthetic-example",
                    "name": "synthetic-example",
                    "city": "synthetic-example",
                    "cityGroupCode": "synthetic-example",
                    "intent": "synthetic-example",
                    "callback": "synthetic-example",
                    "unitLabel": "synthetic-example",
                    "routingDescription": "synthetic-example",
                    "createsRegularBoardPost": false,
                    "isDefaultRequestBoard": false,
                    "isDefaultListingBoard": false,
                    "routingEnabled": false,
                    "selected": false
                },
                "targetDisplayName": "synthetic-example",
                "locationName": "synthetic-example",
                "locationAlias": "synthetic-example",
                "title": "synthetic-example",
                "subtitle": "synthetic-example",
                "prompt": "synthetic-example",
                "ctaLabel": "synthetic-example",
                "completed": false,
                "targetUserID": 0,
                "targetAlias": "synthetic-example",
                "targetProfileURL": "synthetic-example",
                "completedPostID": 0,
                "completedPostURL": "synthetic-example",
                "viewURL": "synthetic-example"
            }
        },
        "copy": {
            "title": "synthetic-example",
            "description": "synthetic-example"
        },
        "submission": {
            "bidID": 0,
            "appointmentID": 0,
            "bidUUID": "synthetic-example",
            "listingUUID": "synthetic-example",
            "revision": "synthetic-example",
            "status": "Draft",
            "submittedAt": "synthetic-example",
            "canCorrect": false,
            "correctionError": "synthetic-example",
            "lifecycle": "held",
            "rejectedByReviewer": false,
            "canSelfReview": false,
            "history": [],
            "historicalDetailsUnavailable": false
        }
    }
}
Documentation du point de terminaison lisible par machine
POST

/v1/bid/set

#
Places a bid Please note that users are required to hold the API Developer medal to access automated buying. A minimum balance of $50 per automatically purchased listings that have not passed by at least 72 hours is required to cover for no-show refunds. Example: If 100 listings for the next 30 days have been purchased the users main account must reflect an available balance (which can be a combination of credit limit and balance) of at least $5,000 to cover for no show refunds. use the associated account workflow to programatically fund your account

Paramètres

NomTypeObligatoireValeur par défautDescription
fundingAccountID int Oui — ID of the account that will fund the bid, accountIDs can be found in /v1/account/get_list
returnToAccountID int Oui — ID of the account that a bid amount shall be returned to if it is cancelled. If 0 it will be returned to the users Main Account. accountIDs can be found in /v1/account/get_list
bidAmount int Oui — bid amount in smallest currency unit
sendPublishingMessages bool Oui — Defines if bid is being published with push messages and emails, if set to false a reduced publishing fee applies.
isPremium bool Oui — Defines if this is a premium publishing bid
locationAlias string Oui — Slug found after the slash when opening a location in the portal
orderListID string Oui — If this bid is part of an orderList, set the ID here.
inventoryTypeID int Oui — inventoryTypeID found in /v1/location/get_inventory_types
numberTimeRangeUnits int Oui — Default is 1 - if this is a bid for multiple days such as a hotel stay or a boat slip specify the number of days.
dateTimeRangeStart string Oui — Time Range Start Date, will be ignored if empty format: YYYY-MM-DD HH:MM:SS
dateTimeRangeEnd string Oui — Time Range End Date, will be ignored if empty format: YYYY-MM-DD HH:MM:SS
isWritingRequest bool Non false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
Exemple de requête (cURL)
curl --request POST \
  'https://fr.appointmenttrader.com/v1/bid/set' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'fundingAccountID={{fundingAccountID}}' \
  --data-urlencode 'returnToAccountID={{returnToAccountID}}' \
  --data-urlencode 'bidAmount={{bidAmount}}' \
  --data-urlencode 'sendPublishingMessages={{sendPublishingMessages}}' \
  --data-urlencode 'isPremium={{isPremium}}' \
  --data-urlencode 'locationAlias={{locationAlias}}' \
  --data-urlencode 'orderListID={{orderListID}}' \
  --data-urlencode 'inventoryTypeID={{inventoryTypeID}}' \
  --data-urlencode 'numberTimeRangeUnits={{numberTimeRangeUnits}}' \
  --data-urlencode 'dateTimeRangeStart={{dateTimeRangeStart}}' \
  --data-urlencode 'dateTimeRangeEnd={{dateTimeRangeEnd}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_set_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payloadobject Oui
$.oneOf[0].allOf[1].Payload.bidIDDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.bidID.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.bidID.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.transactionIDDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.transactionID.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.transactionID.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenboolean NonResponse projection adds this flag when a bid context is present; true hides the buyer while any of their qualifying response races is open.
$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenUntilinteger | null NonLatest saved closing timestamp among the buyer's qualifying open response races, in Unix seconds, or null when identity is visible.
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set",
    "RequestUserAlias": "example-user",
    "Payload": {
        "bidID": 0,
        "transactionID": 0
    }
}
Documentation du point de terminaison lisible par machine
POST

/v1/bid/set_cancel

#
Cancels an active bid

Paramètres

NomTypeObligatoireValeur par défautDescription
bidID int Oui — bidID returned by /v1/bid/set and /v1/bid/get_list functions Bid must be created by acting API User and must not be held by another user
isWritingRequest bool Non false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
Exemple de requête (cURL)
curl --request POST \
  'https://fr.appointmenttrader.com/v1/bid/set_cancel' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_set_cancel_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payload = "Bid Cancelled" Oui
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_cancel",
    "RequestUserAlias": "example-user",
    "Payload": "Bid Cancelled"
}
Documentation du point de terminaison lisible par machine
POST

/v1/bid/set_drop

#
Release a bid currently held by the acting seller.

Paramètres

NomTypeObligatoireValeur par défautDescription
bidID int Oui — numeric bid ID
isWritingRequest bool Non false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data
Exemple de requête (cURL)
curl --request POST \
  'https://fr.appointmenttrader.com/v1/bid/set_drop' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_set_drop_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payloadobject Oui
$.oneOf[0].allOf[1].Payload.success = true Oui
$.oneOf[0].allOf[1].Payload.messagestring Oui
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_drop",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "message": "synthetic-example"
    }
}
Documentation du point de terminaison lisible par machine
POST

/v1/bid/set_feedback

#
Send seller feedback for a bid, such as no connection or bid too low.

Paramètres

NomTypeObligatoireValeur par défautDescription
bidID int Oui — numeric bid ID
reason string Non "no_connection" one of unfollow_location, no_connection, bid_too_low, short_list, un_short_list. unfollow_location requires confirmation in the client and clears venue feedback.
suggestedAmount int Non 0 optional replacement amount for bid_too_low
isWritingRequest bool Non false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data
Exemple de requête (cURL)
curl --request POST \
  'https://fr.appointmenttrader.com/v1/bid/set_feedback' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'reason={{reason}}' \
  --data-urlencode 'suggestedAmount={{suggestedAmount}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_set_feedback_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payloadobject Oui
$.oneOf[0].allOf[1].Payload.success = true Oui
$.oneOf[0].allOf[1].Payload.feedbackTypestring ["LOCATION_UNFOLLOWED","NO_CONNECTION","BID_TOO_LOW","SHORT_LIST","UN_SHORT_LIST"] Oui
$.oneOf[0].allOf[1].Payload.discussionCommentPostID Oui
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[1]null Oui
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_feedback",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "feedbackType": "LOCATION_UNFOLLOWED",
        "discussionCommentPostID": 0
    }
}
Documentation du point de terminaison lisible par machine
POST

/v1/bid/set_note

#
Save the acting seller's private note for a bid.

Paramètres

NomTypeObligatoireValeur par défautDescription
bidID int Oui — numeric bid ID
note string Oui — private seller note
isWritingRequest bool Non false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data
Exemple de requête (cURL)
curl --request POST \
  'https://fr.appointmenttrader.com/v1/bid/set_note' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'note={{note}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_set_note_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payload = true Oui
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_note",
    "RequestUserAlias": "example-user",
    "Payload": true
}
Documentation du point de terminaison lisible par machine
POST

/v1/bid/set_pickup

#
Pick up and hold a bid for the acting seller, or return auctionRequired and auctionURL when paid pickup is required. An auction redirect is not a hold. Use /v1/bidauction/get_state and /v1/bidauction/set_checkout to compete. New open bids return poolRequired and poolURL. Use /v1/bidpool/get_state and /v1/bidpool/set_response to submit a private completion promise. Direct hires, existing holds and existing paid pickup auctions retain their terms.

Paramètres

NomTypeObligatoireValeur par défautDescription
bidID int Oui — numeric bid ID
isInstantFill bool Non false true when the seller is already filling immediately
isWritingRequest bool Non false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data
Exemple de requête (cURL)
curl --request POST \
  'https://fr.appointmenttrader.com/v1/bid/set_pickup' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isInstantFill={{isInstantFill}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_set_pickup_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].PayloadBidPickupResult Oui
$.oneOf[0].allOf[1].Payload.anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.anyOf[0].success = false Oui
$.oneOf[0].allOf[1].Payload.anyOf[0].poolRequired = true Oui
$.oneOf[0].allOf[1].Payload.anyOf[0].poolURLstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[0].messagestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[1]object Oui
$.oneOf[0].allOf[1].Payload.anyOf[1].success = false Oui
$.oneOf[0].allOf[1].Payload.anyOf[1].auctionRequired = true Oui
$.oneOf[0].allOf[1].Payload.anyOf[1].auctionURLstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[1].messagestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2]object Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].success = true Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].appointmentIDinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].appointmentUUIDstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].respondByTimestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].respondByLabelstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].messagestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].requestModestring ["general","specific"] Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].operationalExpiry Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].operationalExpiry.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].operationalExpiry.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptionsarray Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[]object Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].ATLocation_IDinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].ATLocationInventoryType_IDinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].TimeRangeUnitCountinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].Quantityinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].LocationNamestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].LocationAliasstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].InventoryTypeNamestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].StartDatestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].EndDatestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].StartTimestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].EndTimestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].PartySize Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].PartySize.anyOf[0]integer Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].PartySize.anyOf[1]null Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].CheckOutDate Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].CheckOutDate.anyOf[0]string Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].CheckOutDate.anyOf[1]null Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].Constraintsarray Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].Constraints[]string Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].ExcludedVenuesarray Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].ExcludedVenues[]string Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].OperationalProjectionboolean NonTrue for a general request’s operational concierge anchor; these dates/location are not resolved fulfillment facts.
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].deliverableTypestring ["fulfillment","research"] Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].researchScope Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].researchScope.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].researchScope.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].bidIDinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].amountinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].buyerUserIDinteger | null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].appointmentIDinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].discussionPostIDinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].bidUUIDstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].createdDatestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderLastUpdateDatestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].amountFormattedstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargetLabelstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationAliasstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationNamestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationAddressstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeNamestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].customRequeststring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].startTimestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].endTimestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].timeLabelstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].buyerAliasstring | null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderAliasstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submissionURLstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].appointmentUUIDstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].appointmentStatusstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].respondByTimestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].respondByLabelstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].fillURLstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].fillListingURLstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].discussionURLstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].privateChatUserAliasstring | null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].privateChatNamestring | null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].notestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].isPremiumboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].isShortlistedboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].isDirectHireboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].isCustomConciergeRequestboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationHasRegulationRestrictionsboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submissionRejectedByReviewerboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargetsarray Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargets[]object Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargets[].userIDinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargets[].aliasstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID.anyOf[1] = "" Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID.anyOf[1] = "" Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderUserID Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderUserID.anyOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderUserID.anyOf[1] = "" Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submissionLifecyclestring ["held","changes_requested","in_review","submitted","confirmation_required","completed","closed"] Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submittedAt Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submittedAt.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submittedAt.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].proposalTokenstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].chatIDinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].chatURLstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].actionButtonIDinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].createdDatestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].proposedLocationNamestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].proposedTimeLabelstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].proposedInventoryTypeNamestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].summarystring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].viewsobject Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.24HoursDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.24Hours.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.24Hours.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.AlltimeDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.Alltime.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.Alltime.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionStateobject Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.statusstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.labelstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.messagestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.sponsorAliasstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.sponsorChatLinkstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.sponsorStatusstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.moveOwnershipUnavailableReasonstring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.moveOwnershipUnavailableMessagestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canPickupboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canDropboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canFillboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canMoveOwnershipboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canShortlistboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canDiscussboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canChatboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.requiresSponsorboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canFillDirectlyboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.fillRateBasisPointsinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.minimumFillRateBasisPointsinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.missingHoldPermissionsarray Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.missingHoldPermissions[]string Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.directFillNoticeboolean Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.directFillAvailabilitystring ["available","unavailable","selection_pending","seller_ineligible"] Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auctionURLstring Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auctionobject Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.venuestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.startTimestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.endTimestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.bidIDinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.bidAmountCentsinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.roundID Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.roundID.anyOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.roundID.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.statestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.serverTimeinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.enabledboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.openingCentsinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.incrementCentsinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.leadingCentsinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.nextCentsinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.estimatedFeesCentsinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.remainingCentsinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.leadingboolean Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.priorityUntilnull Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.priorityMine = false Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffersarray Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[]object Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[].idinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[].amountCentsinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[].statestring Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[].refundCentsinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.eligibilityError Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.eligibilityError.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.eligibilityError.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.buyerIdentityHiddenboolean NonTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.buyerIdentityHiddenUntilinteger | null NonLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.poolRequiredboolean Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0]object Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0].roundIDinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0].statestring ["collecting","immediate"] Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0].closesAtinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0].serverTimeinteger Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[1]null Non
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].buyerIdentityHiddenboolean NonTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].buyerIdentityHiddenUntilinteger | null NonLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].discussionCommentPostID Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].discussionCommentPostID.anyOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.anyOf[2].discussionCommentPostID.anyOf[1]null Oui
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_pickup",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": false,
        "poolRequired": true,
        "poolURL": "synthetic-example",
        "message": "synthetic-example"
    }
}
Documentation du point de terminaison lisible par machine
POST

/v1/bid/set_reservation_contact

#
Saves the bidder-specified reservation contact details for an active bid.

Paramètres

NomTypeObligatoireValeur par défautDescription
bidID int Oui — bidID returned by /v1/bid/set and /v1/bid/get_list functions
reservationName string Oui — Name the reservation should be made under
phoneNumber string Non "" Phone number the reservation should be made under
emailAddress string Non "" Email address the reservation should be made under
isWritingRequest bool Non false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data
Exemple de requête (cURL)
curl --request POST \
  'https://fr.appointmenttrader.com/v1/bid/set_reservation_contact' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'reservationName={{reservationName}}' \
  --data-urlencode 'phoneNumber={{phoneNumber}}' \
  --data-urlencode 'emailAddress={{emailAddress}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_set_reservation_contact_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payloadobject Oui
$.oneOf[0].allOf[1].Payload.bidIDinteger Oui
$.oneOf[0].allOf[1].Payload.reservationNamestring Oui
$.oneOf[0].allOf[1].Payload.phoneNumberstring Oui
$.oneOf[0].allOf[1].Payload.emailAddressstring Oui
$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenboolean NonResponse projection adds this flag when a bid context is present; true hides the buyer while any of their qualifying response races is open.
$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenUntilinteger | null NonLatest saved closing timestamp among the buyer's qualifying open response races, in Unix seconds, or null when identity is visible.
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_reservation_contact",
    "RequestUserAlias": "example-user",
    "Payload": {
        "bidID": 0,
        "reservationName": "synthetic-example",
        "phoneNumber": "synthetic-example",
        "emailAddress": "synthetic-example"
    }
}
Documentation du point de terminaison lisible par machine
POST

/v1/bid/set_shortlist

#
Shortlist or un-shortlist a bid for the acting seller.

Paramètres

NomTypeObligatoireValeur par défautDescription
bidID int Oui — numeric bid ID
isShortlisted bool Non true true to shortlist, false to remove from shortlist
isWritingRequest bool Non false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data
Exemple de requête (cURL)
curl --request POST \
  'https://fr.appointmenttrader.com/v1/bid/set_shortlist' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isShortlisted={{isShortlisted}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_set_shortlist_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payloadobject Oui
$.oneOf[0].allOf[1].Payload.success = true Oui
$.oneOf[0].allOf[1].Payload.feedbackTypestring ["LOCATION_UNFOLLOWED","NO_CONNECTION","BID_TOO_LOW","SHORT_LIST","UN_SHORT_LIST"] Oui
$.oneOf[0].allOf[1].Payload.discussionCommentPostID Oui
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0]DatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0].oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0].oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[1]null Oui
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_shortlist",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "feedbackType": "LOCATION_UNFOLLOWED",
        "discussionCommentPostID": 0
    }
}
Documentation du point de terminaison lisible par machine
POST

/v1/bid/set_text_feedback

#
Post custom feedback to the bid discussion and resolve the acting concierge's pending feedback.

Paramètres

NomTypeObligatoireValeur par défautDescription
bidID int Oui — numeric bid ID
text string Non "" response text, 1 to 250 characters.
isWritingRequest bool Non false must be true to submit
Exemple de requête (cURL)
curl --request POST \
  'https://fr.appointmenttrader.com/v1/bid/set_text_feedback' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'text={{text}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$bid_set_text_feedback_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payloadobject Oui
$.oneOf[0].allOf[1].Payload.success = true Oui
$.oneOf[0].allOf[1].Payload.discussionCommentPostIDinteger Oui
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_text_feedback",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "discussionCommentPostID": 0
    }
}
Documentation du point de terminaison lisible par machine