Online nu  

/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.

Parameters

NaamTypeVerplichtStandaardBeschrijving
search string Nee "" optional literal text to match.
Voorbeeldverzoek (cURL)
curl --get \
  'https://nl.appointmenttrader.com/v1/bid/get_feedback_suggestions' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'search={{search}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_get_feedback_suggestions_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadarray Ja
$.oneOf[0].allOf[1].Payload[]object Nee
$.oneOf[0].allOf[1].Payload[].textstring Ja
$.oneOf[0].allOf[1].Payload[].lastUsedstring Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/get_feedback_suggestions",
    "RequestUserAlias": "example-user",
    "Payload": []
}
Machineleesbare endpointdocumentatie
GET

/v1/bid/get_list

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
creatorUserAlias string Nee "" Alias of user who created the bids, if empty all bids will be returned
locationAlias string Nee "" locationAlias if this item is a bid. Slug found after the slash when opening a location in the portal
pageSize int Nee 5000 Defines how many results will be return per request
pageNumber int Nee 0 Defines which page should be returned
Voorbeeldverzoek (cURL)
curl --get \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_get_list_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Ja
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.Name = "All Active Bids" Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.NumberBidsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.VolumeActiveBidsnumber Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.Descriptionstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidIDDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidID.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidID.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidUUIDstring | null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidCreatedDatestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidAmountDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidAmount.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidAmount.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isPremiumDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isPremium.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isPremium.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationName Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationName.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationName.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].communityBidDiscussionLink Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].communityBidDiscussionLink.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].communityBidDiscussionLink.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidStartTimestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidEndTimestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidCreatorUserAlias Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidCreatorUserAlias.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidCreatorUserAlias.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].heldByUserAlias Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].heldByUserAlias.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].heldByUserAlias.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].customSearchRequestString Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].customSearchRequestString.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].customSearchRequestString.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatusobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.statusstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.labelstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.messagestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.sponsorAliasstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.sponsorChatLinkstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.sponsorStatusstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.moveOwnershipUnavailableReasonstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.moveOwnershipUnavailableMessagestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canPickupboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canDropboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canFillboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canMoveOwnershipboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canShortlistboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canDiscussboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canChatboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.requiresSponsorboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canFillDirectlyboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.fillRateBasisPointsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.minimumFillRateBasisPointsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.missingHoldPermissionsarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.missingHoldPermissions[]string Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.directFillNoticeboolean Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.directFillAvailabilitystring ["available","unavailable","selection_pending","seller_ineligible"] Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auctionURLstring Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auctionobject Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.venuestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.startTimestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.endTimestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.bidIDinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.bidAmountCentsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.roundID Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.roundID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.roundID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.statestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.serverTimeinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt.anyOf[0]DatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.enabledboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.openingCentsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.incrementCentsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.leadingCentsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.nextCentsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.estimatedFeesCentsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.remainingCentsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.leadingboolean Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.priorityUntilnull Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.priorityMine = false Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffersarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[]object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[].idinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[].amountCentsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[].statestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[].refundCentsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.eligibilityError Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.eligibilityError.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.eligibilityError.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID.anyOf[0]DatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.buyerIdentityHiddenboolean NeeTrue 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 NeeLatest 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 Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0]object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0].roundIDinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0].statestring ["collecting","immediate"] Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0].closesAtinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0].serverTimeinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[1]null Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAddress Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAddress.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAddress.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].buyerIdentityHiddenboolean NeeTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].buyerIdentityHiddenUntilinteger | null NeeLatest 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 Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string Nee
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "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": []
        }
    }
}
Machineleesbare endpointdocumentatie
GET

/v1/bid/get_pickup_requirements

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
bidID int Ja — numeric bid ID
Voorbeeldverzoek (cURL)
curl --get \
  'https://nl.appointmenttrader.com/v1/bid/get_pickup_requirements' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_get_pickup_requirements_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.bidobject Ja
$.oneOf[0].allOf[1].Payload.bid.requestModestring ["general","specific"] Ja
$.oneOf[0].allOf[1].Payload.bid.operationalExpiry Ja
$.oneOf[0].allOf[1].Payload.bid.operationalExpiry.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.bid.operationalExpiry.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptionsarray Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[]object Nee
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].ATLocation_IDinteger Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].ATLocationInventoryType_IDinteger Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].TimeRangeUnitCountinteger Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].Quantityinteger Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].LocationNamestring Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].LocationAliasstring Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].InventoryTypeNamestring Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].StartDatestring Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].EndDatestring Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].StartTimestring Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].EndTimestring Ja
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].PartySize Nee
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].PartySize.anyOf[0]integer Nee
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].PartySize.anyOf[1]null Nee
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].CheckOutDate Nee
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].CheckOutDate.anyOf[0]string Nee
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].CheckOutDate.anyOf[1]null Nee
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].Constraintsarray Nee
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].Constraints[]string Nee
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].ExcludedVenuesarray Nee
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].ExcludedVenues[]string Nee
$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].OperationalProjectionboolean NeeTrue 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"] Ja
$.oneOf[0].allOf[1].Payload.bid.researchScope Ja
$.oneOf[0].allOf[1].Payload.bid.researchScope.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.bid.researchScope.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.bid.bidIDinteger Ja
$.oneOf[0].allOf[1].Payload.bid.amountinteger Ja
$.oneOf[0].allOf[1].Payload.bid.buyerUserIDinteger | null Ja
$.oneOf[0].allOf[1].Payload.bid.appointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.bid.discussionPostIDinteger Ja
$.oneOf[0].allOf[1].Payload.bid.bidUUIDstring Ja
$.oneOf[0].allOf[1].Payload.bid.createdDatestring Ja
$.oneOf[0].allOf[1].Payload.bid.currentHolderLastUpdateDatestring Ja
$.oneOf[0].allOf[1].Payload.bid.amountFormattedstring Ja
$.oneOf[0].allOf[1].Payload.bid.directHireTargetLabelstring Ja
$.oneOf[0].allOf[1].Payload.bid.locationAliasstring Ja
$.oneOf[0].allOf[1].Payload.bid.locationNamestring Ja
$.oneOf[0].allOf[1].Payload.bid.locationAddressstring Ja
$.oneOf[0].allOf[1].Payload.bid.inventoryTypeNamestring Ja
$.oneOf[0].allOf[1].Payload.bid.customRequeststring Ja
$.oneOf[0].allOf[1].Payload.bid.startTimestring Ja
$.oneOf[0].allOf[1].Payload.bid.endTimestring Ja
$.oneOf[0].allOf[1].Payload.bid.timeLabelstring Ja
$.oneOf[0].allOf[1].Payload.bid.buyerAliasstring | null Ja
$.oneOf[0].allOf[1].Payload.bid.currentHolderAliasstring Ja
$.oneOf[0].allOf[1].Payload.bid.submissionURLstring Ja
$.oneOf[0].allOf[1].Payload.bid.appointmentUUIDstring Ja
$.oneOf[0].allOf[1].Payload.bid.appointmentStatusstring Ja
$.oneOf[0].allOf[1].Payload.bid.respondByTimestring Ja
$.oneOf[0].allOf[1].Payload.bid.respondByLabelstring Ja
$.oneOf[0].allOf[1].Payload.bid.fillURLstring Ja
$.oneOf[0].allOf[1].Payload.bid.fillListingURLstring Ja
$.oneOf[0].allOf[1].Payload.bid.discussionURLstring Ja
$.oneOf[0].allOf[1].Payload.bid.privateChatUserAliasstring | null Ja
$.oneOf[0].allOf[1].Payload.bid.privateChatNamestring | null Ja
$.oneOf[0].allOf[1].Payload.bid.notestring Ja
$.oneOf[0].allOf[1].Payload.bid.isPremiumboolean Ja
$.oneOf[0].allOf[1].Payload.bid.isShortlistedboolean Ja
$.oneOf[0].allOf[1].Payload.bid.isDirectHireboolean Ja
$.oneOf[0].allOf[1].Payload.bid.isCustomConciergeRequestboolean Ja
$.oneOf[0].allOf[1].Payload.bid.locationHasRegulationRestrictionsboolean Ja
$.oneOf[0].allOf[1].Payload.bid.submissionRejectedByReviewerboolean Ja
$.oneOf[0].allOf[1].Payload.bid.directHireTargetsarray Ja
$.oneOf[0].allOf[1].Payload.bid.directHireTargets[]object Nee
$.oneOf[0].allOf[1].Payload.bid.directHireTargets[].userIDinteger Ja
$.oneOf[0].allOf[1].Payload.bid.directHireTargets[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.bid.locationID Ja
$.oneOf[0].allOf[1].Payload.bid.locationID.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.bid.locationID.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.bid.locationID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.bid.locationID.anyOf[1] = "" Ja
$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID Ja
$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID.anyOf[1] = "" Ja
$.oneOf[0].allOf[1].Payload.bid.currentHolderUserID Ja
$.oneOf[0].allOf[1].Payload.bid.currentHolderUserID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.bid.currentHolderUserID.anyOf[1] = "" Ja
$.oneOf[0].allOf[1].Payload.bid.submissionLifecyclestring ["held","changes_requested","in_review","submitted","confirmation_required","completed","closed"] Ja
$.oneOf[0].allOf[1].Payload.bid.submittedAt Ja
$.oneOf[0].allOf[1].Payload.bid.submittedAt.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.bid.submittedAt.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal Ja
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].proposalTokenstring Ja
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].chatIDinteger Ja
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].chatURLstring Ja
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].actionButtonIDinteger Ja
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].createdDatestring Ja
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].proposedLocationNamestring Ja
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].proposedTimeLabelstring Ja
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].proposedInventoryTypeNamestring Ja
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].summarystring Ja
$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.bid.viewsobject Ja
$.oneOf[0].allOf[1].Payload.bid.views.24HoursDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.bid.views.24Hours.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.bid.views.24Hours.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.bid.views.AlltimeDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.bid.views.Alltime.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.bid.views.Alltime.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.bid.actionStateobject Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.statusstring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.labelstring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.messagestring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.sponsorAliasstring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.sponsorChatLinkstring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.sponsorStatusstring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.moveOwnershipUnavailableReasonstring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.moveOwnershipUnavailableMessagestring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.canPickupboolean Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.canDropboolean Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.canFillboolean Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.canMoveOwnershipboolean Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.canShortlistboolean Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.canDiscussboolean Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.canChatboolean Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.requiresSponsorboolean Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.canFillDirectlyboolean Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.fillRateBasisPointsinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.minimumFillRateBasisPointsinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.missingHoldPermissionsarray Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.missingHoldPermissions[]string Nee
$.oneOf[0].allOf[1].Payload.bid.actionState.directFillNoticeboolean Nee
$.oneOf[0].allOf[1].Payload.bid.actionState.directFillAvailabilitystring ["available","unavailable","selection_pending","seller_ineligible"] Nee
$.oneOf[0].allOf[1].Payload.bid.actionState.auctionURLstring Nee
$.oneOf[0].allOf[1].Payload.bid.actionState.auctionobject Nee
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.venuestring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.startTimestring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.endTimestring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.bidIDinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.bidAmountCentsinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.roundID Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.roundID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.roundID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.statestring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.serverTimeinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt.anyOf[0]DatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.enabledboolean Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.openingCentsinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.incrementCentsinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.leadingCentsinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.nextCentsinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.estimatedFeesCentsinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.remainingCentsinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.leadingboolean Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.priorityUntilnull Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.priorityMine = false Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffersarray Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[]object Nee
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[].idinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[].amountCentsinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[].statestring Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[].refundCentsinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.eligibilityError Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.eligibilityError.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.eligibilityError.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID.anyOf[0]DatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.auction.buyerIdentityHiddenboolean NeeTrue 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 NeeLatest 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 Nee
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound Nee
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0]object Nee
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0].roundIDinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0].statestring ["collecting","immediate"] Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0].closesAtinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0].serverTimeinteger Ja
$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[1]null Nee
$.oneOf[0].allOf[1].Payload.bid.buyerIdentityHiddenboolean NeeTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.bid.buyerIdentityHiddenUntilinteger | null NeeLatest 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 Ja
$.oneOf[0].allOf[1].Payload.actionState.statusstring Ja
$.oneOf[0].allOf[1].Payload.actionState.labelstring Ja
$.oneOf[0].allOf[1].Payload.actionState.messagestring Ja
$.oneOf[0].allOf[1].Payload.actionState.sponsorAliasstring Ja
$.oneOf[0].allOf[1].Payload.actionState.sponsorChatLinkstring Ja
$.oneOf[0].allOf[1].Payload.actionState.sponsorStatusstring Ja
$.oneOf[0].allOf[1].Payload.actionState.moveOwnershipUnavailableReasonstring Ja
$.oneOf[0].allOf[1].Payload.actionState.moveOwnershipUnavailableMessagestring Ja
$.oneOf[0].allOf[1].Payload.actionState.canPickupboolean Ja
$.oneOf[0].allOf[1].Payload.actionState.canDropboolean Ja
$.oneOf[0].allOf[1].Payload.actionState.canFillboolean Ja
$.oneOf[0].allOf[1].Payload.actionState.canMoveOwnershipboolean Ja
$.oneOf[0].allOf[1].Payload.actionState.canShortlistboolean Ja
$.oneOf[0].allOf[1].Payload.actionState.canDiscussboolean Ja
$.oneOf[0].allOf[1].Payload.actionState.canChatboolean Ja
$.oneOf[0].allOf[1].Payload.actionState.requiresSponsorboolean Ja
$.oneOf[0].allOf[1].Payload.actionState.canFillDirectlyboolean Ja
$.oneOf[0].allOf[1].Payload.actionState.fillRateBasisPointsinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.minimumFillRateBasisPointsinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.missingHoldPermissionsarray Ja
$.oneOf[0].allOf[1].Payload.actionState.missingHoldPermissions[]string Nee
$.oneOf[0].allOf[1].Payload.actionState.directFillNoticeboolean Nee
$.oneOf[0].allOf[1].Payload.actionState.directFillAvailabilitystring ["available","unavailable","selection_pending","seller_ineligible"] Nee
$.oneOf[0].allOf[1].Payload.actionState.auctionURLstring Nee
$.oneOf[0].allOf[1].Payload.actionState.auctionobject Nee
$.oneOf[0].allOf[1].Payload.actionState.auction.venuestring Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.startTimestring Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.endTimestring Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.bidIDinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.bidAmountCentsinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.roundID Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.roundID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.roundID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.statestring Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.serverTimeinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.enabledboolean Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.openingCentsinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.incrementCentsinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.leadingCentsinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.nextCentsinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.estimatedFeesCentsinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.remainingCentsinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.leadingboolean Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.priorityUntilnull Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.priorityMine = false Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffersarray Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[]object Nee
$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[].idinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[].amountCentsinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[].statestring Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[].refundCentsinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.eligibilityError Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.eligibilityError.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.eligibilityError.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.actionState.auction.buyerIdentityHiddenboolean NeeTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload.actionState.auction.buyerIdentityHiddenUntilinteger | null NeeLatest 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 Nee
$.oneOf[0].allOf[1].Payload.actionState.responseRound Nee
$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0]object Nee
$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0].roundIDinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0].statestring ["collecting","immediate"] Ja
$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0].closesAtinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0].serverTimeinteger Ja
$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[1]null Nee
$.oneOf[0].allOf[1].Payload.maxHoldDays Ja
$.oneOf[0].allOf[1].Payload.maxHoldDays.anyOf[0]DatabaseNumber JaNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.maxHoldDays.anyOf[0].oneOf[0]number Ja
$.oneOf[0].allOf[1].Payload.maxHoldDays.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.maxHoldDays.anyOf[1]boolean Ja
$.oneOf[0].allOf[1].Payload.maxCurrentHolds Ja
$.oneOf[0].allOf[1].Payload.maxCurrentHolds.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.maxCurrentHolds.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.maxCurrentHolds.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.maxCurrentHolds.anyOf[1]boolean Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "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
    }
}
Machineleesbare endpointdocumentatie
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.
Voorbeeldverzoek (cURL)
curl --get \
  'https://nl.appointmenttrader.com/v1/bid/get_required_feedback' \
  --data-urlencode 'key={{API_KEY}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_get_required_feedback_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadarray Ja
$.oneOf[0].allOf[1].Payload[]object Nee
$.oneOf[0].allOf[1].Payload[].ATLocation_IDDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ATLocation_ID.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload[].ATLocation_ID.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload[].FeedbackLocationNamestring Ja
$.oneOf[0].allOf[1].Payload[].ATLocation_Aliasstring Ja
$.oneOf[0].allOf[1].Payload[].ATLocation_Namestring Ja
$.oneOf[0].allOf[1].Payload[].ATBids_AmountDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ATBids_Amount.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload[].ATBids_Amount.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload[].StartTimestring Ja
$.oneOf[0].allOf[1].Payload[].EndTimestring Ja
$.oneOf[0].allOf[1].Payload[].ATLocationInventoryType_Name Ja
$.oneOf[0].allOf[1].Payload[].ATLocationInventoryType_Name.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload[].ATLocationInventoryType_Name.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload[].RequestString Ja
$.oneOf[0].allOf[1].Payload[].RequestString.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload[].RequestString.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID Ja
$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload[].BidUUIDstring | null Ja
$.oneOf[0].allOf[1].Payload[].ATBids_IDDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ATBids_ID.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload[].ATBids_ID.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload[].ATBids_IsPremiumDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ATBids_IsPremium.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload[].ATBids_IsPremium.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload[].buyerIdentityHiddenboolean NeeTrue when the viewer cannot see the buyer because that buyer has an open response race.
$.oneOf[0].allOf[1].Payload[].buyerIdentityHiddenUntilinteger | null NeeLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/get_required_feedback",
    "RequestUserAlias": "example-user",
    "Payload": []
}
Machineleesbare endpointdocumentatie
GET

/v1/bid/get_submission

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
bidID int Ja — Bid ID.
Voorbeeldverzoek (cURL)
curl --get \
  'https://nl.appointmenttrader.com/v1/bid/get_submission' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_get_submission_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload Ja
$.oneOf[0].allOf[1].Payload.oneOf[0]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].mode = "detail" Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0].totalinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0].submittedinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0].urlstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0].transactionIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].appointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].listingUUIDstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].accessobject Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].access.rolestring ["owner","shared","reviewer","guest","transfer-agent","submission"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].access.canViewFullboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].access.isOwnerboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].access.isSharedGuestboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].access.isReviewerboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].access.isUnlockedDetailboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].access.authorizedByShareCodeboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].access.readOnly = true Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].locationobject Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].location.idinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].location.namestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].location.aliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].location.addressstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].location.googleMapsURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].location.cityLinestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].location.timezonestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].location.imageURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservationobject Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.refundStatusLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.descriptorstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.inventoryNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.datestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.timestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.dateLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.timeLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.dateTimeLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.partySizeLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.checkInNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.emailstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.phonestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.detailStatementstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.purchaseSummarystring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.purchaseAmountFormattedstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.status Ja
$.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"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.status.anyOf[1] = "" Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.headcountinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFieldsarray Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[]object Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].idinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].labelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].descriptionstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].typestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].valuestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.isPastboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].peopleobject Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].people.ownerAliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].people.creatorAliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guestsReservationGuests Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].shareURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].headcountinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].confirmedCountinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].pendingSlotsinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].itemsarray Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[]object Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].kindstring ["owner","shared"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].namestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].statusstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].lastSeenLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].reviewReservationReview Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[1].canReview = false Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[1].isActive = false Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].revisionstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].canReview = true Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].isActive = true Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].needsBeginboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].isInProgressboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].isSelfReviewboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].reviewRewardEligibleboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].reviewRewardPointsinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].askingPriceSmallestUnitinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].reviewRewardFormattedstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].askingPriceFormattedstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].questionstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].respondByDatestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].respondByTimestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].respondByLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].legacyReviewURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[0].amountFormattedstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[0].discussionURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].historyarray Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[]object Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].createdLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].statusstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].descriptionstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].descriptionHTMLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].reviewerAliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actionsReservationActions Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].shareURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceCheckoutURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServicePriceLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceLocationNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceInventoryNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceDateLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceTimeLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reportProblemURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].refundChatURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].refundChatV2URLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].sellerChatURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].sellerChatV2URLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].absoluteShareURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addServiceAppointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServicePriceSmallestUnitinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].refundChatIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].sellerChatIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addServiceAvailableboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].manageAvailableboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reportInfractionAvailableboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellAvailableboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferServiceobject Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.visibleboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestAvailableboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.cancelAvailableboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.isRequestedboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.isInTransferboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.isCompletedboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.isFailedboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.appointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.typestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.statusstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.listingUUIDstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.currentNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedGivenNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedFamilyNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedByAliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedAtstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestEndpointstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.cancelEndpointstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].reviewRequestIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoardIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].boardIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetLocationIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].appointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetTypestring ["user","location"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetRolestring ["buyer","seller","location"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].boardIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].countinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].slugstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].namestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].citystring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].cityGroupCodestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].intentstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].callbackstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].unitLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].routingDescriptionstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].createsRegularBoardPostboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].isDefaultRequestBoardboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].isDefaultListingBoardboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].routingEnabledboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].selectedboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetDisplayNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].locationNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].locationAliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].subtitlestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].promptstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].ctaLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].completedboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetUserIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetAliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetProfileURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].completedPostIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].completedPostURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].viewURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0]LocationReviewAction Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].reviewRequestIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoardIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].boardIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetLocationIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].appointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetTypestring ["user","location"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetRolestring ["buyer","seller","location"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].boardIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].countinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].slugstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].namestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].citystring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].cityGroupCodestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].intentstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].callbackstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].unitLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].routingDescriptionstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].createsRegularBoardPostboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].isDefaultRequestBoardboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].isDefaultListingBoardboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].routingEnabledboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].selectedboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetDisplayNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].locationNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].locationAliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].subtitlestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].promptstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].ctaLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].completedboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetUserIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetAliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetProfileURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].completedPostIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].completedPostURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].viewURLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].reviewRequestIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoardIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].boardIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetLocationIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].appointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetTypestring ["user","location"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetRolestring ["buyer","seller","location"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].boardIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].countinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].slugstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].namestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].citystring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].cityGroupCodestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].intentstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].callbackstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].unitLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].routingDescriptionstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].createsRegularBoardPostboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].isDefaultRequestBoardboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].isDefaultListingBoardboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].routingEnabledboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].selectedboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetDisplayNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].locationNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].locationAliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].titlestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].subtitlestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].promptstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].ctaLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].completedboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellEndpointstring Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellListingIDstring Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellLocationNamestring Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellInventoryNamestring Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellDateLabelstring Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellTimeLabelstring Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellAppointmentIDinteger Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellCurrentPriceSmallestUnitinteger Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellMinPriceinteger Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellMaxPriceinteger Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellTransferFeeBasisPointsinteger Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellRequiresReviewboolean Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSelfReviewAvailableboolean Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellRelistOriginalboolean Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffersarray Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers[]object Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers[].timeLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers[].priceLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers[].inventoryTypestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[1]array Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].copyobject Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].copy.titlestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].copy.descriptionstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submissionobject Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.bidIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.appointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.bidUUIDstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.listingUUIDstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.revisionstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.statusstring ["Draft","Submitted","In Review","Rejected","CONFIRMATION_REQUIRED","COMPLETED","CLOSED"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.submittedAt Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.submittedAt.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.submittedAt.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.canCorrectboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.correctionError Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.correctionError.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.correctionError.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.lifecyclestring ["held","changes_requested","in_review","submitted","confirmation_required","completed","closed"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.rejectedByReviewerboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.canSelfReviewboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.historyarray Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[]object Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].idinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].reviewerUserIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].createdDatestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].createdLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].statusstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].descriptionstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].descriptionTextstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].descriptionHTMLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].reviewerAliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translationobject Nee
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.contextstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.endpointstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.sourceLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.targetLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.receiverLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.targetLanguageNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.sourceContentHashstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.titlestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.bodystring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.originalTitlestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.originalBodystring Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.reviewHistoryIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.notificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.statestring ["done","eligible"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.eligibleboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.cachedboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.historicalDetailsUnavailableboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[0].submission.buyerIdentityHiddenboolean NeeTrue 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 NeeLatest 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 Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].mode = "submission-receipt" Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].appointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].listingUUIDstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].accessobject Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].access.role = "submission" Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].access.readOnly = true Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].reservationarray Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].actionsarray Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submissionobject Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.bidIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.appointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.bidUUIDstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.listingUUIDstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.revisionstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.statusstring ["Draft","Submitted","In Review","Rejected","CONFIRMATION_REQUIRED","COMPLETED","CLOSED"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.submittedAt Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.submittedAt.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.submittedAt.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.canCorrectboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.correctionError Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.correctionError.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.correctionError.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.lifecyclestring ["held","changes_requested","in_review","submitted","confirmation_required","completed","closed"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.rejectedByReviewerboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.canSelfReviewboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.historyarray Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[]object Nee
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].idinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].reviewerUserIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].createdDatestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].createdLabelstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].statusstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].descriptionstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].descriptionTextstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].descriptionHTMLstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].reviewerAliasstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translationobject Nee
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.contextstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.endpointstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.sourceLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.targetLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.receiverLanguageCodestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.targetLanguageNamestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.sourceContentHashstring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.titlestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.bodystring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.originalTitlestring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.originalBodystring Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.reviewHistoryIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.notificationIDinteger Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.statestring ["done","eligible"] Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.eligibleboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.cachedboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.historicalDetailsUnavailableboolean Ja
$.oneOf[0].allOf[1].Payload.oneOf[1].submission.buyerIdentityHiddenboolean NeeTrue 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 NeeLatest saved ClosesAt among the buyer's open response races, as Unix seconds; null when visible. Reveal requires a fresh authoritative response.
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "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
        }
    }
}
Machineleesbare endpointdocumentatie
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

Parameters

NaamTypeVerplichtStandaardBeschrijving
fundingAccountID int Ja — ID of the account that will fund the bid, accountIDs can be found in /v1/account/get_list
returnToAccountID int Ja — 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 Ja — bid amount in smallest currency unit
sendPublishingMessages bool Ja — Defines if bid is being published with push messages and emails, if set to false a reduced publishing fee applies.
isPremium bool Ja — Defines if this is a premium publishing bid
locationAlias string Ja — Slug found after the slash when opening a location in the portal
orderListID string Ja — If this bid is part of an orderList, set the ID here.
inventoryTypeID int Ja — inventoryTypeID found in /v1/location/get_inventory_types
numberTimeRangeUnits int Ja — 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 Ja — Time Range Start Date, will be ignored if empty format: YYYY-MM-DD HH:MM:SS
dateTimeRangeEnd string Ja — Time Range End Date, will be ignored if empty format: YYYY-MM-DD HH:MM:SS
isWritingRequest bool Nee 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
Voorbeeldverzoek (cURL)
curl --request POST \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_set_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.bidIDDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.bidID.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.bidID.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.transactionIDDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.transactionID.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.transactionID.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenboolean NeeResponse 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 NeeLatest saved closing timestamp among the buyer's qualifying open response races, in Unix seconds, or null when identity is visible.
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set",
    "RequestUserAlias": "example-user",
    "Payload": {
        "bidID": 0,
        "transactionID": 0
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/bid/set_cancel

#
Cancels an active bid

Parameters

NaamTypeVerplichtStandaardBeschrijving
bidID int Ja — 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 Nee 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
Voorbeeldverzoek (cURL)
curl --request POST \
  'https://nl.appointmenttrader.com/v1/bid/set_cancel' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_set_cancel_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload = "Bid Cancelled" Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_cancel",
    "RequestUserAlias": "example-user",
    "Payload": "Bid Cancelled"
}
Machineleesbare endpointdocumentatie
POST

/v1/bid/set_drop

#
Release a bid currently held by the acting seller.

Parameters

NaamTypeVerplichtStandaardBeschrijving
bidID int Ja — numeric bid ID
isWritingRequest bool Nee false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data
Voorbeeldverzoek (cURL)
curl --request POST \
  'https://nl.appointmenttrader.com/v1/bid/set_drop' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_set_drop_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.success = true Ja
$.oneOf[0].allOf[1].Payload.messagestring Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_drop",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "message": "synthetic-example"
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/bid/set_feedback

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
bidID int Ja — numeric bid ID
reason string Nee "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 Nee 0 optional replacement amount for bid_too_low
isWritingRequest bool Nee false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data
Voorbeeldverzoek (cURL)
curl --request POST \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_set_feedback_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.success = true Ja
$.oneOf[0].allOf[1].Payload.feedbackTypestring ["LOCATION_UNFOLLOWED","NO_CONNECTION","BID_TOO_LOW","SHORT_LIST","UN_SHORT_LIST"] Ja
$.oneOf[0].allOf[1].Payload.discussionCommentPostID Ja
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[1]null Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_feedback",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "feedbackType": "LOCATION_UNFOLLOWED",
        "discussionCommentPostID": 0
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/bid/set_note

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
bidID int Ja — numeric bid ID
note string Ja — private seller note
isWritingRequest bool Nee false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data
Voorbeeldverzoek (cURL)
curl --request POST \
  'https://nl.appointmenttrader.com/v1/bid/set_note' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'note={{note}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_set_note_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload = true Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_note",
    "RequestUserAlias": "example-user",
    "Payload": true
}
Machineleesbare endpointdocumentatie
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.

Parameters

NaamTypeVerplichtStandaardBeschrijving
bidID int Ja — numeric bid ID
isInstantFill bool Nee false true when the seller is already filling immediately
isWritingRequest bool Nee false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data
Voorbeeldverzoek (cURL)
curl --request POST \
  'https://nl.appointmenttrader.com/v1/bid/set_pickup' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isInstantFill={{isInstantFill}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_set_pickup_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].PayloadBidPickupResult Ja
$.oneOf[0].allOf[1].Payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].success = false Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].poolRequired = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].poolURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].messagestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].success = false Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].auctionRequired = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].auctionURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].messagestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].success = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].appointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].appointmentUUIDstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].respondByTimestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].respondByLabelstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].messagestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].requestModestring ["general","specific"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].operationalExpiry Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].operationalExpiry.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].operationalExpiry.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptionsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].ATLocation_IDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].ATLocationInventoryType_IDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].TimeRangeUnitCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].Quantityinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].LocationNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].LocationAliasstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].InventoryTypeNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].StartDatestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].EndDatestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].StartTimestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].EndTimestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].PartySize Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].PartySize.anyOf[0]integer Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].PartySize.anyOf[1]null Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].CheckOutDate Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].CheckOutDate.anyOf[0]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].CheckOutDate.anyOf[1]null Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].Constraintsarray Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].Constraints[]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].ExcludedVenuesarray Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].ExcludedVenues[]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].OperationalProjectionboolean NeeTrue 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"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].researchScope Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].researchScope.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].researchScope.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].bidIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].amountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].buyerUserIDinteger | null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].appointmentIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].discussionPostIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].bidUUIDstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].createdDatestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderLastUpdateDatestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].amountFormattedstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargetLabelstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationAliasstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationAddressstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].customRequeststring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].startTimestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].endTimestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].timeLabelstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].buyerAliasstring | null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderAliasstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submissionURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].appointmentUUIDstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].appointmentStatusstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].respondByTimestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].respondByLabelstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].fillURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].fillListingURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].discussionURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].privateChatUserAliasstring | null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].privateChatNamestring | null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].notestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].isPremiumboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].isShortlistedboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].isDirectHireboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].isCustomConciergeRequestboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationHasRegulationRestrictionsboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submissionRejectedByReviewerboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargetsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargets[]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargets[].userIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargets[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID.anyOf[0]DatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID.anyOf[1] = "" Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID.anyOf[0]DatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID.anyOf[1] = "" Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderUserID Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderUserID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderUserID.anyOf[1] = "" Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submissionLifecyclestring ["held","changes_requested","in_review","submitted","confirmation_required","completed","closed"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submittedAt Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submittedAt.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submittedAt.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].proposalTokenstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].chatIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].chatURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].actionButtonIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].createdDatestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].proposedLocationNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].proposedTimeLabelstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].proposedInventoryTypeNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].summarystring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].viewsobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.24HoursDatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.24Hours.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.AlltimeDatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.Alltime.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionStateobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.statusstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.labelstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.messagestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.sponsorAliasstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.sponsorChatLinkstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.sponsorStatusstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.moveOwnershipUnavailableReasonstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.moveOwnershipUnavailableMessagestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canPickupboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canDropboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canFillboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canMoveOwnershipboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canShortlistboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canDiscussboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canChatboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.requiresSponsorboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canFillDirectlyboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.fillRateBasisPointsinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.minimumFillRateBasisPointsinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.missingHoldPermissionsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.missingHoldPermissions[]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.directFillNoticeboolean Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.directFillAvailabilitystring ["available","unavailable","selection_pending","seller_ineligible"] Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auctionURLstring Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auctionobject Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.venuestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.startTimestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.endTimestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.bidIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.bidAmountCentsinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.roundID Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.roundID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.roundID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.statestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.serverTimeinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt.anyOf[0]DatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.enabledboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.openingCentsinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.incrementCentsinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.leadingCentsinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.nextCentsinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.estimatedFeesCentsinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.remainingCentsinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.leadingboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.priorityUntilnull Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.priorityMine = false Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffersarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[].idinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[].amountCentsinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[].statestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[].refundCentsinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.eligibilityError Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.eligibilityError.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.eligibilityError.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID.anyOf[0]DatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.buyerIdentityHiddenboolean NeeTrue 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 NeeLatest 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 Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0].roundIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0].statestring ["collecting","immediate"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0].closesAtinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0].serverTimeinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[1]null Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].buyerIdentityHiddenboolean NeeTrue 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 NeeLatest 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 Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].discussionCommentPostID Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].discussionCommentPostID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].discussionCommentPostID.anyOf[1]null Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "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"
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/bid/set_reservation_contact

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
bidID int Ja — bidID returned by /v1/bid/set and /v1/bid/get_list functions
reservationName string Ja — Name the reservation should be made under
phoneNumber string Nee "" Phone number the reservation should be made under
emailAddress string Nee "" Email address the reservation should be made under
isWritingRequest bool Nee false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data
Voorbeeldverzoek (cURL)
curl --request POST \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_set_reservation_contact_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.bidIDinteger Ja
$.oneOf[0].allOf[1].Payload.reservationNamestring Ja
$.oneOf[0].allOf[1].Payload.phoneNumberstring Ja
$.oneOf[0].allOf[1].Payload.emailAddressstring Ja
$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenboolean NeeResponse 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 NeeLatest saved closing timestamp among the buyer's qualifying open response races, in Unix seconds, or null when identity is visible.
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "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"
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/bid/set_shortlist

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
bidID int Ja — numeric bid ID
isShortlisted bool Nee true true to shortlist, false to remove from shortlist
isWritingRequest bool Nee false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data
Voorbeeldverzoek (cURL)
curl --request POST \
  'https://nl.appointmenttrader.com/v1/bid/set_shortlist' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isShortlisted={{isShortlisted}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_set_shortlist_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.success = true Ja
$.oneOf[0].allOf[1].Payload.feedbackTypestring ["LOCATION_UNFOLLOWED","NO_CONNECTION","BID_TOO_LOW","SHORT_LIST","UN_SHORT_LIST"] Ja
$.oneOf[0].allOf[1].Payload.discussionCommentPostID Ja
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[1]null Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_shortlist",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "feedbackType": "LOCATION_UNFOLLOWED",
        "discussionCommentPostID": 0
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/bid/set_text_feedback

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
bidID int Ja — numeric bid ID
text string Nee "" response text, 1 to 250 characters.
isWritingRequest bool Nee false must be true to submit
Voorbeeldverzoek (cURL)
curl --request POST \
  'https://nl.appointmenttrader.com/v1/bid/set_text_feedback' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'text={{text}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$bid_set_text_feedback_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.success = true Ja
$.oneOf[0].allOf[1].Payload.discussionCommentPostIDinteger Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_text_feedback",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "discussionCommentPostID": 0
    }
}
Machineleesbare endpointdocumentatie