bid API reference | AppointmentTrader

Search all endpoints

/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

Name	Type	Required	Default	Description
`search`	`string`	`No`	`""`	optional literal text to match.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/bid/get_feedback_suggestions' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'search={{search}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`bid_get_feedback_suggestions_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload[].text`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].lastUsed`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/get_feedback_suggestions",
    "RequestUserAlias": "example-user",
    "Payload": []
}

Machine-readable endpoint documentation

GET

/v1/bid/get_list

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

Parameters

Name	Type	Required	Default	Description
`creatorUserAlias`	`string`	`No`	`""`	Alias of user who created the bids, if empty all bids will be returned
`locationAlias`	`string`	`No`	`""`	locationAlias if this item is a bid. Slug found after the slash when opening a location in the portal
`pageSize`	`int`	`No`	`5000`	Defines how many results will be return per request
`pageNumber`	`int`	`No`	`0`	Defines which page should be returned

Request example (cURL)

curl --get \
  'https://ca.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}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`bid_get_list_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`= "All Active Bids"`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.NumberBids`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.VolumeActiveBids`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.Description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidUUID`	`string \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidCreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidAmount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidAmount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidAmount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isPremium`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isPremium.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].isPremium.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationName`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationName.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].communityBidDiscussionLink`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].communityBidDiscussionLink.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].communityBidDiscussionLink.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidStartTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidEndTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidTimeRangeUnitCount.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidCreatorUserAlias`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidCreatorUserAlias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidCreatorUserAlias.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].heldByUserAlias`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].heldByUserAlias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].heldByUserAlias.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].customSearchRequestString`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].customSearchRequestString.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].customSearchRequestString.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.message`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.sponsorAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.sponsorChatLink`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.sponsorStatus`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.moveOwnershipUnavailableReason`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.moveOwnershipUnavailableMessage`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canPickup`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canDrop`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canFill`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canMoveOwnership`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canShortlist`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canDiscuss`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canChat`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.requiresSponsor`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.canFillDirectly`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.fillRateBasisPoints`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.minimumFillRateBasisPoints`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.missingHoldPermissions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.missingHoldPermissions[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.directFillNotice`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.directFillAvailability`	`string ["available","unavailable","selection_pending","seller_ineligible"]`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auctionURL`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.venue`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.startTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.endTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.bidAmountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.roundID`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.roundID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.roundID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.state`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.serverTime`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer 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`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.closesAt.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.enabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.openingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.incrementCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.leadingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.nextCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.estimatedFeesCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.remainingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.leading`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.priorityUntil`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.priorityMine`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[].amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[].state`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.ownOffers[].refundCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.eligibilityError`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.eligibilityError.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.eligibilityError.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer 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`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.holdAppointmentID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.auction.buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.poolRequired`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound`		`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0].roundID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0].state`	`string ["collecting","immediate"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0].closesAt`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[0].serverTime`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].pickupAvailabilityStatus.responseRound.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAddress`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAddress.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAddress.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]`	`string`	`No`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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": []
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/bid/get_pickup_requirements

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

Parameters

Name	Type	Required	Default	Description
`bidID`	`int`	`Yes`	`—`	numeric bid ID

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/bid/get_pickup_requirements' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`bid_get_pickup_requirements_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.requestMode`	`string ["general","specific"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.operationalExpiry`		`Yes`
`$.oneOf[0].allOf[1].Payload.bid.operationalExpiry.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.operationalExpiry.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].ATLocation_ID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].ATLocationInventoryType_ID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].TimeRangeUnitCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].Quantity`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].LocationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].LocationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].InventoryTypeName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].StartDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].EndDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].StartTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].EndTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].PartySize`		`No`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].PartySize.anyOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].PartySize.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].CheckOutDate`		`No`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].CheckOutDate.anyOf[0]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].CheckOutDate.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].Constraints`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].Constraints[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].ExcludedVenues`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].ExcludedVenues[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.bid.acceptedOptions[].OperationalProjection`	`boolean`	`No`	True for a general request’s operational concierge anchor; these dates/location are not resolved fulfillment facts.
`$.oneOf[0].allOf[1].Payload.bid.deliverableType`	`string ["fulfillment","research"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.researchScope`		`Yes`
`$.oneOf[0].allOf[1].Payload.bid.researchScope.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.researchScope.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.amount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.buyerUserID`	`integer \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.discussionPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.bidUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.currentHolderLastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.amountFormatted`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.directHireTargetLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.locationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.locationAddress`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.inventoryTypeName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.customRequest`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.startTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.endTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.buyerAlias`	`string \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.currentHolderAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.submissionURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.appointmentUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.appointmentStatus`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.respondByTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.respondByLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.fillURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.fillListingURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.discussionURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.privateChatUserAlias`	`string \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.privateChatName`	`string \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.note`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.isPremium`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.isShortlisted`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.isDirectHire`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.isCustomConciergeRequest`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.locationHasRegulationRestrictions`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.submissionRejectedByReviewer`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.directHireTargets`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.directHireTargets[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.bid.directHireTargets[].userID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.directHireTargets[].alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.locationID`		`Yes`
`$.oneOf[0].allOf[1].Payload.bid.locationID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bid.locationID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.locationID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.locationID.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID`		`Yes`
`$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.inventoryTypeID.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.currentHolderUserID`		`Yes`
`$.oneOf[0].allOf[1].Payload.bid.currentHolderUserID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.currentHolderUserID.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.submissionLifecycle`	`string ["held","changes_requested","in_review","submitted","confirmation_required","completed","closed"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.submittedAt`		`Yes`
`$.oneOf[0].allOf[1].Payload.bid.submittedAt.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.submittedAt.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal`		`Yes`
`$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].proposalToken`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].chatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].chatURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].actionButtonID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].proposedLocationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].proposedTimeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].proposedInventoryTypeName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[0].summary`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.pendingChangeProposal.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.views`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.views.24Hours`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bid.views.24Hours.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.views.24Hours.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.views.Alltime`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bid.views.Alltime.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.views.Alltime.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.message`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.sponsorAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.sponsorChatLink`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.sponsorStatus`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.moveOwnershipUnavailableReason`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.moveOwnershipUnavailableMessage`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.canPickup`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.canDrop`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.canFill`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.canMoveOwnership`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.canShortlist`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.canDiscuss`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.canChat`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.requiresSponsor`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.canFillDirectly`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.fillRateBasisPoints`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.minimumFillRateBasisPoints`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.missingHoldPermissions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.missingHoldPermissions[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.bid.actionState.directFillNotice`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.bid.actionState.directFillAvailability`	`string ["available","unavailable","selection_pending","seller_ineligible"]`	`No`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auctionURL`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.venue`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.startTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.endTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.bidAmountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.roundID`		`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.roundID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.roundID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.state`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.serverTime`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt`		`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer 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`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.closesAt.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.enabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.openingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.incrementCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.leadingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.nextCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.estimatedFeesCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.remainingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.leading`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.priorityUntil`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.priorityMine`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[].amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[].state`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.ownOffers[].refundCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.eligibilityError`		`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.eligibilityError.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.eligibilityError.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID`		`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer 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`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.holdAppointmentID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.bid.actionState.auction.buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[0].allOf[1].Payload.bid.actionState.poolRequired`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound`		`No`
`$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0].roundID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0].state`	`string ["collecting","immediate"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0].closesAt`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[0].serverTime`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bid.actionState.responseRound.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.bid.buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.bid.buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[0].allOf[1].Payload.actionState`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.message`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.sponsorAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.sponsorChatLink`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.sponsorStatus`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.moveOwnershipUnavailableReason`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.moveOwnershipUnavailableMessage`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.canPickup`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.canDrop`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.canFill`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.canMoveOwnership`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.canShortlist`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.canDiscuss`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.canChat`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.requiresSponsor`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.canFillDirectly`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.fillRateBasisPoints`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.minimumFillRateBasisPoints`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.missingHoldPermissions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.missingHoldPermissions[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.actionState.directFillNotice`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.actionState.directFillAvailability`	`string ["available","unavailable","selection_pending","seller_ineligible"]`	`No`
`$.oneOf[0].allOf[1].Payload.actionState.auctionURL`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.actionState.auction`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.actionState.auction.venue`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.startTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.endTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.bidAmountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.roundID`		`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.roundID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.roundID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.state`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.serverTime`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt`		`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.closesAt.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.enabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.openingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.incrementCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.leadingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.nextCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.estimatedFeesCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.remainingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.leading`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.priorityUntil`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.priorityMine`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[].amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[].state`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.ownOffers[].refundCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.eligibilityError`		`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.eligibilityError.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.eligibilityError.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID`		`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.holdAppointmentID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.auction.buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.actionState.auction.buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[0].allOf[1].Payload.actionState.poolRequired`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.actionState.responseRound`		`No`
`$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0].roundID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0].state`	`string ["collecting","immediate"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0].closesAt`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[0].serverTime`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.actionState.responseRound.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.maxHoldDays`		`Yes`
`$.oneOf[0].allOf[1].Payload.maxHoldDays.anyOf[0]`	`DatabaseNumber`	`Yes`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.maxHoldDays.anyOf[0].oneOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.maxHoldDays.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.maxHoldDays.anyOf[1]`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.maxCurrentHolds`		`Yes`
`$.oneOf[0].allOf[1].Payload.maxCurrentHolds.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.maxCurrentHolds.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.maxCurrentHolds.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.maxCurrentHolds.anyOf[1]`	`boolean`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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
    }
}

Machine-readable endpoint documentation

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.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/bid/get_required_feedback' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`bid_get_required_feedback_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload[].ATLocation_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].ATLocation_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATLocation_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].FeedbackLocationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATLocation_Alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATLocation_Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATBids_Amount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].ATBids_Amount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATBids_Amount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].StartTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].EndTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATLocationInventoryType_Name`		`Yes`
`$.oneOf[0].allOf[1].Payload[].ATLocationInventoryType_Name.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATLocationInventoryType_Name.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload[].RequestString`		`Yes`
`$.oneOf[0].allOf[1].Payload[].RequestString.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].RequestString.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATDiscussionPosts_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload[].BidUUID`	`string \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATBids_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].ATBids_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATBids_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATBids_IsPremium`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].ATBids_IsPremium.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].ATBids_IsPremium.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload[].buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/get_required_feedback",
    "RequestUserAlias": "example-user",
    "Payload": []
}

Machine-readable endpoint documentation

GET

/v1/bid/get_submission

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

Parameters

Name	Type	Required	Default	Description
`bidID`	`int`	`Yes`	`—`	Bid ID.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/bid/get_submission' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`bid_get_submission_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].mode`	`= "detail"`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0].total`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0].submitted`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0].url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[0].transactionID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].customerSurveys.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].listingUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].access`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].access.role`	`string ["owner","shared","reviewer","guest","transfer-agent","submission"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].access.canViewFull`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].access.isOwner`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].access.isSharedGuest`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].access.isReviewer`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].access.isUnlockedDetail`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].access.authorizedByShareCode`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].access.readOnly`	`= true`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].location`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].location.id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].location.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].location.alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].location.address`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].location.googleMapsURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].location.cityLine`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].location.timezone`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].location.imageURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.refundStatusLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.descriptor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.inventoryName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.date`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.time`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.dateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.dateTimeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.partySizeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.checkInName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.email`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.phone`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.detailStatement`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.purchaseSummary`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.purchaseAmountFormatted`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.status`		`Yes`
`$.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"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.status.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.headcount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].type`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.customFields[].value`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].reservation.isPast`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].people`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].people.ownerAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].people.creatorAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests`	`ReservationGuests`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].shareURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].headcount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].confirmedCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].pendingSlots`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].kind`	`string ["owner","shared"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].guests.anyOf[1].items[].lastSeenLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review`	`ReservationReview`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[1].canReview`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[1].isActive`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].revision`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].canReview`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].isActive`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].needsBegin`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].isInProgress`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].isSelfReview`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].reviewRewardEligible`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].reviewRewardPoints`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].askingPriceSmallestUnit`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].reviewRewardFormatted`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].askingPriceFormatted`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].question`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].respondByDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].respondByTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].respondByLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].legacyReviewURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[0].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[0].amountFormatted`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[0].discussionURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].bid.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].descriptionHTML`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].review.anyOf[2].history[].reviewerAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions`	`ReservationActions`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].shareURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceCheckoutURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServicePriceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceLocationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceInventoryName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServiceTimeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reportProblemURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].refundChatURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].refundChatV2URL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].sellerChatURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].sellerChatV2URL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].absoluteShareURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addServiceAppointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addTransferServicePriceSmallestUnit`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].refundChatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].sellerChatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].addServiceAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].manageAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reportInfractionAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.visible`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.cancelAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.isRequested`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.isInTransfer`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.isCompleted`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.isFailed`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.type`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.listingUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.currentName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedGivenName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedFamilyName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestedAt`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.requestEndpoint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].transferService.cancelEndpoint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].reviewRequestID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetLocationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].locationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetType`	`string ["user","location"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetRole`	`string ["buyer","seller","location"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].count`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].cityGroupCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].intent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].callback`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].unitLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].routingDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].createsRegularBoardPost`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].isDefaultRequestBoard`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].isDefaultListingBoard`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].routingEnabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].selected`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetDisplayName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].locationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].subtitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].prompt`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].ctaLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].completed`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].completedPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].completedPostURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[0].viewURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].reviewRequest.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0]`	`LocationReviewAction`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].reviewRequestID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetLocationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].locationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetType`	`string ["user","location"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetRole`	`string ["buyer","seller","location"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].count`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].cityGroupCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].intent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].callback`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].unitLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].routingDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].createsRegularBoardPost`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].isDefaultRequestBoard`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].isDefaultListingBoard`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].routingEnabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].selected`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetDisplayName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].locationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].subtitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].prompt`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].ctaLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].completed`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].completedPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].completedPostURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].viewURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].reviewRequestID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetLocationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].locationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetType`	`string ["user","location"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetRole`	`string ["buyer","seller","location"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].count`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].cityGroupCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].intent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].callback`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].unitLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].routingDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].createsRegularBoardPost`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].isDefaultRequestBoard`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].isDefaultListingBoard`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].routingEnabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].selected`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetDisplayName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].locationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].subtitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].prompt`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].ctaLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].completed`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].locationReview.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellEndpoint`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellListingID`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellLocationName`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellInventoryName`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellDateLabel`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellTimeLabel`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellAppointmentID`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellCurrentPriceSmallestUnit`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellMinPrice`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellMaxPrice`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellTransferFeeBasisPoints`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellRequiresReview`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSelfReviewAvailable`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellRelistOriginal`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers[].timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers[].priceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[0].resellSameDayOffers[].inventoryType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].actions.anyOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].copy`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].copy.title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].copy.description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.bidUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.listingUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.revision`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.status`	`string ["Draft","Submitted","In Review","Rejected","CONFIRMATION_REQUIRED","COMPLETED","CLOSED"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.submittedAt`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.submittedAt.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.submittedAt.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.canCorrect`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.correctionError`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.correctionError.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.correctionError.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.lifecycle`	`string ["held","changes_requested","in_review","submitted","confirmation_required","completed","closed"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.rejectedByReviewer`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.canSelfReview`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].reviewerUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].descriptionText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].descriptionHTML`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].reviewerAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.context`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.endpoint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.sourceLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.targetLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.receiverLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.targetLanguageName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.sourceContentHash`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.body`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.originalTitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.originalBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.reviewHistoryID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.notificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.state`	`string ["done","eligible"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.eligible`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.history[].translation.cached`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.historicalDetailsUnavailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.oneOf[0].submission.buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[0].allOf[1].Payload.oneOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].mode`	`= "submission-receipt"`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].listingUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].access`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].access.role`	`= "submission"`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].access.readOnly`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].reservation`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].actions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.bidUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.listingUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.revision`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.status`	`string ["Draft","Submitted","In Review","Rejected","CONFIRMATION_REQUIRED","COMPLETED","CLOSED"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.submittedAt`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.submittedAt.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.submittedAt.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.canCorrect`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.correctionError`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.correctionError.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.correctionError.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.lifecycle`	`string ["held","changes_requested","in_review","submitted","confirmation_required","completed","closed"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.rejectedByReviewer`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.canSelfReview`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].reviewerUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].descriptionText`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].descriptionHTML`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].reviewerAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.context`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.endpoint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.sourceLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.targetLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.receiverLanguageCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.targetLanguageName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.sourceContentHash`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.body`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.originalTitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.originalBody`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.reviewHistoryID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.notificationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.state`	`string ["done","eligible"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.eligible`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.history[].translation.cached`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.historicalDetailsUnavailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.oneOf[1].submission.buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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
        }
    }
}

Machine-readable endpoint documentation

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

Name	Type	Required	Default	Description
`fundingAccountID`	`int`	`Yes`	`—`	ID of the account that will fund the bid, accountIDs can be found in /v1/account/get_list
`returnToAccountID`	`int`	`Yes`	`—`	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`	`Yes`	`—`	bid amount in smallest currency unit
`sendPublishingMessages`	`bool`	`Yes`	`—`	Defines if bid is being published with push messages and emails, if set to false a reduced publishing fee applies.
`isPremium`	`bool`	`Yes`	`—`	Defines if this is a premium publishing bid
`locationAlias`	`string`	`Yes`	`—`	Slug found after the slash when opening a location in the portal
`orderListID`	`string`	`Yes`	`—`	If this bid is part of an orderList, set the ID here.
`inventoryTypeID`	`int`	`Yes`	`—`	inventoryTypeID found in /v1/location/get_inventory_types
`numberTimeRangeUnits`	`int`	`Yes`	`—`	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`	`Yes`	`—`	Time Range Start Date, will be ignored if empty format: YYYY-MM-DD HH:MM:SS
`dateTimeRangeEnd`	`string`	`Yes`	`—`	Time Range End Date, will be ignored if empty format: YYYY-MM-DD HH:MM:SS
`isWritingRequest`	`bool`	`No`	`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

Request example (cURL)

curl --request POST \
  'https://ca.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}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`bid_set_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.bidID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bidID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bidID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.transactionID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.transactionID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.transactionID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.buyerIdentityHidden`	`boolean`	`No`	Response projection adds this flag when a bid context is present; true hides the buyer during the current race.
`$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved race closing timestamp in Unix seconds, or null when identity is visible.
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set",
    "RequestUserAlias": "example-user",
    "Payload": {
        "bidID": 0,
        "transactionID": 0
    }
}

Machine-readable endpoint documentation

POST

/v1/bid/set_cancel

Cancels an active bid

Parameters

Name	Type	Required	Default	Description
`bidID`	`int`	`Yes`	`—`	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`	`No`	`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

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/bid/set_cancel' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`bid_set_cancel_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`= "Bid Cancelled"`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_cancel",
    "RequestUserAlias": "example-user",
    "Payload": "Bid Cancelled"
}

Machine-readable endpoint documentation

POST

/v1/bid/set_drop

Release a bid currently held by the acting seller.

Parameters

Name	Type	Required	Default	Description
`bidID`	`int`	`Yes`	`—`	numeric bid ID
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/bid/set_drop' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`bid_set_drop_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.success`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.message`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_drop",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "message": "synthetic-example"
    }
}

Machine-readable endpoint documentation

POST

/v1/bid/set_feedback

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

Parameters

Name	Type	Required	Default	Description
`bidID`	`int`	`Yes`	`—`	numeric bid ID
`reason`	`string`	`No`	`"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`	`No`	`0`	optional replacement amount for bid_too_low
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data

Request example (cURL)

curl --request POST \
  'https://ca.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}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`bid_set_feedback_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.success`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.feedbackType`	`string ["LOCATION_UNFOLLOWED","NO_CONNECTION","BID_TOO_LOW","SHORT_LIST","UN_SHORT_LIST"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.discussionCommentPostID`		`Yes`
`$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[1]`	`null`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_feedback",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "feedbackType": "LOCATION_UNFOLLOWED",
        "discussionCommentPostID": 0
    }
}

Machine-readable endpoint documentation

POST

/v1/bid/set_note

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

Parameters

Name	Type	Required	Default	Description
`bidID`	`int`	`Yes`	`—`	numeric bid ID
`note`	`string`	`Yes`	`—`	private seller note
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/bid/set_note' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'note={{note}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`bid_set_note_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`= true`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_note",
    "RequestUserAlias": "example-user",
    "Payload": true
}

Machine-readable endpoint documentation

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

Name	Type	Required	Default	Description
`bidID`	`int`	`Yes`	`—`	numeric bid ID
`isInstantFill`	`bool`	`No`	`false`	true when the seller is already filling immediately
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/bid/set_pickup' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isInstantFill={{isInstantFill}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`bid_set_pickup_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`BidPickupResult`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].success`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].poolRequired`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].poolURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].message`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[1].success`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[1].auctionRequired`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[1].auctionURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[1].message`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].success`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].appointmentUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].respondByTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].respondByLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].message`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].requestMode`	`string ["general","specific"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].operationalExpiry`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].operationalExpiry.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].operationalExpiry.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].ATLocation_ID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].ATLocationInventoryType_ID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].TimeRangeUnitCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].Quantity`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].LocationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].LocationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].InventoryTypeName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].StartDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].EndDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].StartTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].EndTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].PartySize`		`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].PartySize.anyOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].PartySize.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].CheckOutDate`		`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].CheckOutDate.anyOf[0]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].CheckOutDate.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].Constraints`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].Constraints[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].ExcludedVenues`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].ExcludedVenues[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].acceptedOptions[].OperationalProjection`	`boolean`	`No`	True 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].deliverableType`	`string ["fulfillment","research"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].researchScope`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].researchScope.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].researchScope.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].amount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].buyerUserID`	`integer \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].discussionPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].bidUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderLastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].amountFormatted`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargetLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationAddress`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].customRequest`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].startTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].endTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].buyerAlias`	`string \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submissionURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].appointmentUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].appointmentStatus`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].respondByTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].respondByLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].fillURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].fillListingURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].discussionURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].privateChatUserAlias`	`string \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].privateChatName`	`string \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].note`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].isPremium`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].isShortlisted`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].isDirectHire`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].isCustomConciergeRequest`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationHasRegulationRestrictions`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submissionRejectedByReviewer`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargets`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargets[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargets[].userID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].directHireTargets[].alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer 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`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].locationID.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer 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`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].inventoryTypeID.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderUserID`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderUserID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].currentHolderUserID.anyOf[1]`	`= ""`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submissionLifecycle`	`string ["held","changes_requested","in_review","submitted","confirmation_required","completed","closed"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submittedAt`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submittedAt.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].submittedAt.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].proposalToken`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].chatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].chatURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].actionButtonID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].proposedLocationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].proposedTimeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].proposedInventoryTypeName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[0].summary`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].pendingChangeProposal.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.24Hours`	`DatabaseInteger`	`Yes`	Integer 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`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.24Hours.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.Alltime`	`DatabaseInteger`	`Yes`	Integer 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`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].views.Alltime.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.message`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.sponsorAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.sponsorChatLink`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.sponsorStatus`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.moveOwnershipUnavailableReason`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.moveOwnershipUnavailableMessage`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canPickup`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canDrop`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canFill`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canMoveOwnership`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canShortlist`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canDiscuss`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canChat`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.requiresSponsor`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.canFillDirectly`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.fillRateBasisPoints`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.minimumFillRateBasisPoints`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.missingHoldPermissions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.missingHoldPermissions[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.directFillNotice`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.directFillAvailability`	`string ["available","unavailable","selection_pending","seller_ineligible"]`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auctionURL`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.venue`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.startTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.endTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.bidAmountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.roundID`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.roundID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.roundID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.state`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.serverTime`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer 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`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.closesAt.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.enabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.openingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.incrementCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.leadingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.nextCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.estimatedFeesCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.remainingCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.leading`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.priorityUntil`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.priorityMine`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[].amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[].state`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.ownOffers[].refundCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.eligibilityError`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.eligibilityError.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.eligibilityError.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer 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`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.holdAppointmentID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.auction.buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.poolRequired`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound`		`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0].roundID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0].state`	`string ["collecting","immediate"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0].closesAt`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[0].serverTime`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].actionState.responseRound.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[0].buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
`$.oneOf[0].allOf[1].Payload.anyOf[2].bid.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].discussionCommentPostID`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].discussionCommentPostID.anyOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[2].discussionCommentPostID.anyOf[1]`	`null`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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"
    }
}

Machine-readable endpoint documentation

POST

/v1/bid/set_reservation_contact

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

Parameters

Name	Type	Required	Default	Description
`bidID`	`int`	`Yes`	`—`	bidID returned by /v1/bid/set and /v1/bid/get_list functions
`reservationName`	`string`	`Yes`	`—`	Name the reservation should be made under
`phoneNumber`	`string`	`No`	`""`	Phone number the reservation should be made under
`emailAddress`	`string`	`No`	`""`	Email address the reservation should be made under
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data

Request example (cURL)

curl --request POST \
  'https://ca.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}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`bid_set_reservation_contact_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.reservationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.phoneNumber`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.emailAddress`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.buyerIdentityHidden`	`boolean`	`No`	Response projection adds this flag when a bid context is present; true hides the buyer during the current race.
`$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenUntil`	`integer \| null`	`No`	Saved race closing timestamp in Unix seconds, or null when identity is visible.
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "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"
    }
}

Machine-readable endpoint documentation

POST

/v1/bid/set_shortlist

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

Parameters

Name	Type	Required	Default	Description
`bidID`	`int`	`Yes`	`—`	numeric bid ID
`isShortlisted`	`bool`	`No`	`true`	true to shortlist, false to remove from shortlist
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/bid/set_shortlist' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isShortlisted={{isShortlisted}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`bid_set_shortlist_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.success`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.feedbackType`	`string ["LOCATION_UNFOLLOWED","NO_CONNECTION","BID_TOO_LOW","SHORT_LIST","UN_SHORT_LIST"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.discussionCommentPostID`		`Yes`
`$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.discussionCommentPostID.anyOf[1]`	`null`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_shortlist",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "feedbackType": "LOCATION_UNFOLLOWED",
        "discussionCommentPostID": 0
    }
}

Machine-readable endpoint documentation

POST

/v1/bid/set_text_feedback

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

Parameters

Name	Type	Required	Default	Description
`bidID`	`int`	`Yes`	`—`	numeric bid ID
`text`	`string`	`No`	`""`	response text, 1 to 250 characters.
`isWritingRequest`	`bool`	`No`	`false`	must be true to submit

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/bid/set_text_feedback' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'text={{text}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`bid_set_text_feedback_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.success`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.discussionCommentPostID`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bid/set_text_feedback",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "discussionCommentPostID": 0
    }
}

Machine-readable endpoint documentation