Online Now  

/v1/auction/

GET

/v1/auction/get_bid_status

#
Read one checkout attempt belonging to the acting buyer, including pending funding.

Parameters

NameTypeRequiredDefaultDescription
bidID int Yes — Auction bid ID returned by /v1/auction/set_bid_checkout.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/auction/get_bid_status' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$auction_get_bid_status_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.bidIDinteger Yes
$.oneOf[0].allOf[1].Payload.listingIDstring Yes
$.oneOf[0].allOf[1].Payload.amountCentsinteger Yes
$.oneOf[0].allOf[1].Payload.statusstring ["PendingFunding","Leading","Outbid","Won","Returned"] Yes
$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenboolean NoResponse projection adds this flag when a bid context is present; true hides the buyer during the current race.
$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenUntilinteger | null NoSaved race closing timestamp in Unix seconds, or null when identity is visible.
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auction/get_bid_status",
    "RequestUserAlias": "example-user",
    "Payload": {
        "bidID": 0,
        "listingID": "synthetic-example",
        "amountCents": 0,
        "status": "PendingFunding"
    }
}
Machine-readable endpoint documentation
GET

/v1/auction/get_detail

#
Public-by-design: public auction information excludes reservation secrets, bidder identities and funding records.

Parameters

NameTypeRequiredDefaultDescription
listingID string Yes — Listing UUID.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/auction/get_detail' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$auction_get_detail_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.listingIDstring Yes
$.oneOf[0].allOf[1].Payload.locationNamestring Yes
$.oneOf[0].allOf[1].Payload.imageUrlstring Yes
$.oneOf[0].allOf[1].Payload.inventoryTypeNamestring Yes
$.oneOf[0].allOf[1].Payload.timezonestring Yes
$.oneOf[0].allOf[1].Payload.statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.cardPriceLabelstring Yes
$.oneOf[0].allOf[1].Payload.cardSummarystring Yes
$.oneOf[0].allOf[1].Payload.urlstring Yes
$.oneOf[0].allOf[1].Payload.auctionIDinteger Yes
$.oneOf[0].allOf[1].Payload.startingPriceCentsinteger Yes
$.oneOf[0].allOf[1].Payload.currentBidCentsinteger Yes
$.oneOf[0].allOf[1].Payload.minimumNextBidCentsinteger Yes
$.oneOf[0].allOf[1].Payload.bidCountinteger Yes
$.oneOf[0].allOf[1].Payload.revisioninteger Yes
$.oneOf[0].allOf[1].Payload.isOpenboolean Yes
$.oneOf[0].allOf[1].Payload.isLeadingboolean Yes
$.oneOf[0].allOf[1].Payload.canAdministrativelyCancelboolean Yes
$.oneOf[0].allOf[1].Payload.canBidboolean Yes
$.oneOf[0].allOf[1].Payload.canManageboolean Yes
$.oneOf[0].allOf[1].Payload.isSellerboolean Yes
$.oneOf[0].allOf[1].Payload.listingStart Yes
$.oneOf[0].allOf[1].Payload.listingStart.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.listingStart.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.serverTime Yes
$.oneOf[0].allOf[1].Payload.serverTime.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.serverTime.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.endsAt Yes
$.oneOf[0].allOf[1].Payload.endsAt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.endsAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.purchaseURL Yes
$.oneOf[0].allOf[1].Payload.purchaseURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.purchaseURL.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.saleModestring ["FixedPrice","Auction"] Yes
$.oneOf[0].allOf[1].Payload.statusstring ["PendingApproval","Open","Settling","Sold","Unsold","Cancelled"] Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auction/get_detail",
    "RequestUserAlias": "example-user",
    "Payload": {
        "listingID": "synthetic-example",
        "locationName": "synthetic-example",
        "imageUrl": "synthetic-example",
        "inventoryTypeName": "synthetic-example",
        "timezone": "synthetic-example",
        "statusLabel": "synthetic-example",
        "cardPriceLabel": "synthetic-example",
        "cardSummary": "synthetic-example",
        "url": "synthetic-example",
        "auctionID": 0,
        "startingPriceCents": 0,
        "currentBidCents": 0,
        "minimumNextBidCents": 0,
        "bidCount": 0,
        "revision": 0,
        "isOpen": false,
        "isLeading": false,
        "canAdministrativelyCancel": false,
        "canBid": false,
        "canManage": false,
        "isSeller": false,
        "listingStart": "synthetic-example",
        "serverTime": "synthetic-example",
        "endsAt": "synthetic-example",
        "purchaseURL": "synthetic-example",
        "saleMode": "FixedPrice",
        "status": "PendingApproval"
    }
}
Machine-readable endpoint documentation
GET

/v1/auction/get_my_bids

#

Parameters

NameTypeRequiredDefaultDescription
pageNumber int No 1 One-based page number.
activeOnly bool No false Only the latest participation per open or settling auction.
Request example (cURL)
curl --get \
  'https://ca.appointmenttrader.com/v1/auction/get_my_bids' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageNumber={{pageNumber}}' \
  --data-urlencode 'activeOnly={{activeOnly}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$auction_get_my_bids_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadarray Yes
$.oneOf[0].allOf[1].Payload[]object No
$.oneOf[0].allOf[1].Payload[].IDDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ID.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].ID.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].ATListingAuctions_IDDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ATListingAuctions_ID.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].ATListingAuctions_ID.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].AmountCentsDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].AmountCents.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].AmountCents.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].Statusstring ["Leading","Outbid","Won","Returned"] Yes
$.oneOf[0].allOf[1].Payload[].ReturnLedger_ID Yes
$.oneOf[0].allOf[1].Payload[].ReturnLedger_ID.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ReturnLedger_ID.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].ReturnLedger_ID.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].ReturnLedger_ID.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload[].ATAppointment_IDDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ATAppointment_ID.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload[].ATAppointment_ID.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload[].AuctionStatusstring ["PendingApproval","Open","Settling","Sold","Unsold","Cancelled"] Yes
$.oneOf[0].allOf[1].Payload[].EndsAtstring Yes
$.oneOf[0].allOf[1].Payload[].ListingUUIDstring Yes
$.oneOf[0].allOf[1].Payload[].LocationNamestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auction/get_my_bids",
    "RequestUserAlias": "example-user",
    "Payload": []
}
Machine-readable endpoint documentation
POST

/v1/auction/set_bid_checkout

#
Prepare a funded auction bid. Opening checkout does not reserve inventory or extend the deadline.

Parameters

NameTypeRequiredDefaultDescription
listingID string Yes — Listing UUID.
amountCents int Yes — Bid in USD cents.
requestID string Yes — Unique 16-64 character retry identifier.
isWritingRequest bool No false Explicit writing guard.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/auction/set_bid_checkout' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'amountCents={{amountCents}}' \
  --data-urlencode 'requestID={{requestID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$auction_set_bid_checkout_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.checkoutURLstring Yes
$.oneOf[0].allOf[1].Payload.bidIDinteger Yes
$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenboolean NoResponse projection adds this flag when a bid context is present; true hides the buyer during the current race.
$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenUntilinteger | null NoSaved race closing timestamp in Unix seconds, or null when identity is visible.
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auction/set_bid_checkout",
    "RequestUserAlias": "example-user",
    "Payload": {
        "checkoutURL": "/modules/bid/bid.php?customarticle=auctionbid&parameters=FAKE_CHECKOUT_TOKEN&donotapply&inline",
        "bidID": 1001
    }
}
Machine-readable endpoint documentation
POST

/v1/auction/set_cancel

#
Cancel a bid-free owned auction, or administratively cancel invalid inventory and return deposits.

Parameters

NameTypeRequiredDefaultDescription
listingID string Yes — Listing UUID.
administrative bool No false Requires listing approval permission.
isWritingRequest bool No false Explicit writing guard.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/auction/set_cancel' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'administrative={{administrative}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$auction_set_cancel_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payload = true Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auction/set_cancel",
    "RequestUserAlias": "example-user",
    "Payload": true
}
Machine-readable endpoint documentation
POST

/v1/auction/set_save

#
Configure an owned listing's sale format before its first funded bid.

Parameters

NameTypeRequiredDefaultDescription
listingID string Yes — Listing UUID.
startingPriceCents int Yes — Starting price in USD cents.
endsAt string No "" ISO timestamp with offset, or venue-local date and time. Empty defaults to 24 hours capped at listing start.
saleMode string No "Auction" Auction or FixedPrice.
isWritingRequest bool No false Explicit writing guard.
Request example (cURL)
curl --request POST \
  'https://ca.appointmenttrader.com/v1/auction/set_save' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'startingPriceCents={{startingPriceCents}}' \
  --data-urlencode 'endsAt={{endsAt}}' \
  --data-urlencode 'saleMode={{saleMode}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$auction_set_save_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.listingIDstring Yes
$.oneOf[0].allOf[1].Payload.locationNamestring Yes
$.oneOf[0].allOf[1].Payload.imageUrlstring Yes
$.oneOf[0].allOf[1].Payload.inventoryTypeNamestring Yes
$.oneOf[0].allOf[1].Payload.timezonestring Yes
$.oneOf[0].allOf[1].Payload.statusLabelstring Yes
$.oneOf[0].allOf[1].Payload.cardPriceLabelstring Yes
$.oneOf[0].allOf[1].Payload.cardSummarystring Yes
$.oneOf[0].allOf[1].Payload.urlstring Yes
$.oneOf[0].allOf[1].Payload.auctionIDinteger Yes
$.oneOf[0].allOf[1].Payload.startingPriceCentsinteger Yes
$.oneOf[0].allOf[1].Payload.currentBidCentsinteger Yes
$.oneOf[0].allOf[1].Payload.minimumNextBidCentsinteger Yes
$.oneOf[0].allOf[1].Payload.bidCountinteger Yes
$.oneOf[0].allOf[1].Payload.revisioninteger Yes
$.oneOf[0].allOf[1].Payload.isOpenboolean Yes
$.oneOf[0].allOf[1].Payload.isLeadingboolean Yes
$.oneOf[0].allOf[1].Payload.canAdministrativelyCancelboolean Yes
$.oneOf[0].allOf[1].Payload.canBidboolean Yes
$.oneOf[0].allOf[1].Payload.canManageboolean Yes
$.oneOf[0].allOf[1].Payload.isSellerboolean Yes
$.oneOf[0].allOf[1].Payload.listingStart Yes
$.oneOf[0].allOf[1].Payload.listingStart.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.listingStart.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.serverTime Yes
$.oneOf[0].allOf[1].Payload.serverTime.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.serverTime.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.endsAt Yes
$.oneOf[0].allOf[1].Payload.endsAt.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.endsAt.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.purchaseURL Yes
$.oneOf[0].allOf[1].Payload.purchaseURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.purchaseURL.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.saleModestring ["FixedPrice","Auction"] Yes
$.oneOf[0].allOf[1].Payload.statusstring ["PendingApproval","Open","Settling","Sold","Unsold","Cancelled"] Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage 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].RequestImpersonatedByUserAliasstring No
Response example
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auction/set_save",
    "RequestUserAlias": "example-user",
    "Payload": {
        "listingID": "synthetic-example",
        "locationName": "synthetic-example",
        "imageUrl": "synthetic-example",
        "inventoryTypeName": "synthetic-example",
        "timezone": "synthetic-example",
        "statusLabel": "synthetic-example",
        "cardPriceLabel": "synthetic-example",
        "cardSummary": "synthetic-example",
        "url": "synthetic-example",
        "auctionID": 0,
        "startingPriceCents": 0,
        "currentBidCents": 0,
        "minimumNextBidCents": 0,
        "bidCount": 0,
        "revision": 0,
        "isOpen": false,
        "isLeading": false,
        "canAdministrativelyCancel": false,
        "canBid": false,
        "canManage": false,
        "isSeller": false,
        "listingStart": "synthetic-example",
        "serverTime": "synthetic-example",
        "endsAt": "synthetic-example",
        "purchaseURL": "synthetic-example",
        "saleMode": "FixedPrice",
        "status": "PendingApproval"
    }
}
Machine-readable endpoint documentation