Riferimento API bidauction | AppointmentTrader

Cerca in tutti gli endpoint

/v1/bidauction/

GET

/v1/bidauction/get_list

Visible paid live auctions, with the acting seller's accepted participation first, then earliest closing. Includes finalizing rounds. Returns 25 cards per page, serverTime, page and total. No competitor identities.

Parametri

Nome	Tipo	Obbligatorio	Predefinito	Descrizione
`page`	`int`	`No`	`1`	One-based page number.

Esempio di richiesta (cURL)

curl --get \
  'https://it.appointmenttrader.com/v1/bidauction/get_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'page={{page}}'

Risposta

JSON

See the shared response schema and synthetic example.

Campi della risposta

Campo	Tipo	Obbligatorio	Descrizione
`$`	`bidauction_get_list_Response`	`Sì`
`$.oneOf[0]`		`Sì`
`$.oneOf[0].allOf[0]`	`object`	`Sì`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Sì`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Sì`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Sì`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Sì`
`$.oneOf[0].allOf[1].Payload`	`object`	`Sì`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].roundID`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].bidID`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].venue`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].request`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].startTime`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].endTime`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].bidAmountCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].leadingCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].nextCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].closesAt`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].participating`	`boolean`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].leading`	`boolean`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers`	`array`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].id`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].amountCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].state`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].ownOffers[].refundCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHidden`	`boolean`	`No`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.items[].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.page`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.pageSize`	`= 25`	`Sì`
`$.oneOf[0].allOf[1].Payload.total`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.serverTime`	`integer`	`Sì`
`$.oneOf[1]`	`object`	`Sì`
`$.oneOf[1].RequestUserAlias`	`string`	`Sì`
`$.oneOf[1].RequestPath`	`string \| null`	`Sì`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Sì`
`$.oneOf[1].ResponseCode`	`integer`	`Sì`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Sì`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Sì`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Sì`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Sì`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Esempio di risposta

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bidauction/get_list",
    "RequestUserAlias": "example-user",
    "Payload": {
        "items": [],
        "page": 1,
        "pageSize": 25,
        "total": 0,
        "serverTime": 0
    }
}

Documentazione dell’endpoint leggibile dalle macchine

GET

/v1/bidauction/get_state

Auction price, fixed deadline and the acting seller's own offers only. Cash amounts are USD cents.

Parametri

Nome	Tipo	Obbligatorio	Predefinito	Descrizione
`bidID`	`int`	`Sì`	`—`	Customer bid ID.
`roundID`	`int`	`No`	`0`	Optional round to retain its outcome after closing. Zero selects the active round.

Esempio di richiesta (cURL)

curl --get \
  'https://it.appointmenttrader.com/v1/bidauction/get_state' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'roundID={{roundID}}'

Risposta

JSON

See the shared response schema and synthetic example.

Campi della risposta

Campo	Tipo	Obbligatorio	Descrizione
`$`	`bidauction_get_state_Response`	`Sì`
`$.oneOf[0]`		`Sì`
`$.oneOf[0].allOf[0]`	`object`	`Sì`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Sì`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Sì`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Sì`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Sì`
`$.oneOf[0].allOf[1].Payload`	`object`	`Sì`
`$.oneOf[0].allOf[1].Payload.venue`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.startTime`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.endTime`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.bidID`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.bidAmountCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.roundID`		`Sì`
`$.oneOf[0].allOf[1].Payload.roundID.anyOf[0]`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.roundID.anyOf[1]`	`null`	`Sì`
`$.oneOf[0].allOf[1].Payload.state`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.serverTime`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.closesAt`		`Sì`
`$.oneOf[0].allOf[1].Payload.closesAt.anyOf[0]`	`DatabaseInteger`	`Sì`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.closesAt.anyOf[0].oneOf[0]`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.closesAt.anyOf[0].oneOf[1]`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.closesAt.anyOf[1]`	`null`	`Sì`
`$.oneOf[0].allOf[1].Payload.enabled`	`boolean`	`Sì`
`$.oneOf[0].allOf[1].Payload.openingCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.incrementCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.leadingCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.nextCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.estimatedFeesCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.remainingCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.leading`	`boolean`	`Sì`
`$.oneOf[0].allOf[1].Payload.priorityUntil`	`null`	`Sì`
`$.oneOf[0].allOf[1].Payload.priorityMine`	`= false`	`Sì`
`$.oneOf[0].allOf[1].Payload.ownOffers`	`array`	`Sì`
`$.oneOf[0].allOf[1].Payload.ownOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ownOffers[].id`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.ownOffers[].amountCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.ownOffers[].state`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.ownOffers[].refundCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.eligibilityError`		`Sì`
`$.oneOf[0].allOf[1].Payload.eligibilityError.anyOf[0]`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.eligibilityError.anyOf[1]`	`null`	`Sì`
`$.oneOf[0].allOf[1].Payload.holdAppointmentID`		`Sì`
`$.oneOf[0].allOf[1].Payload.holdAppointmentID.anyOf[0]`	`DatabaseInteger`	`Sì`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.holdAppointmentID.anyOf[0].oneOf[0]`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.holdAppointmentID.anyOf[0].oneOf[1]`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.holdAppointmentID.anyOf[1]`	`null`	`Sì`
`$.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`	`Sì`
`$.oneOf[1].RequestUserAlias`	`string`	`Sì`
`$.oneOf[1].RequestPath`	`string \| null`	`Sì`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Sì`
`$.oneOf[1].ResponseCode`	`integer`	`Sì`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Sì`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Sì`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Sì`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Sì`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Esempio di risposta

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bidauction/get_state",
    "RequestUserAlias": "example-user",
    "Payload": {
        "venue": "synthetic-example",
        "startTime": "synthetic-example",
        "endTime": "synthetic-example",
        "bidID": 0,
        "bidAmountCents": 0,
        "roundID": 0,
        "state": "synthetic-example",
        "serverTime": 0,
        "closesAt": 0,
        "enabled": false,
        "openingCents": 0,
        "incrementCents": 0,
        "leadingCents": 0,
        "nextCents": 0,
        "estimatedFeesCents": 0,
        "remainingCents": 0,
        "leading": false,
        "priorityUntil": null,
        "priorityMine": false,
        "ownOffers": [],
        "eligibilityError": "synthetic-example",
        "holdAppointmentID": 0
    }
}

Documentazione dell’endpoint leggibile dalle macchine

POST

/v1/bidauction/set_checkout

Creates a seller-bound checkout for the full next cash offer. This does not reserve a bid or the leading position. Normal fulfillment fees are additional. Outbid or unusable card payments return to AT balance.

Parametri

Nome	Tipo	Obbligatorio	Predefinito	Descrizione
`bidID`	`int`	`Sì`	`—`	Customer bid ID.
`negativeProceedsAccepted`	`bool`	`No`	`false`	Explicit acknowledgment that total estimated cost can exceed payout.
`isWritingRequest`	`bool`	`No`	`false`	Must be true to create a checkout.

Esempio di richiesta (cURL)

curl --request POST \
  'https://it.appointmenttrader.com/v1/bidauction/set_checkout' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'negativeProceedsAccepted={{negativeProceedsAccepted}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Risposta

JSON

See the shared response schema and synthetic example.

Campi della risposta

Campo	Tipo	Obbligatorio
`$`	`bidauction_set_checkout_Response`	`Sì`
`$.oneOf[0]`		`Sì`
`$.oneOf[0].allOf[0]`	`object`	`Sì`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Sì`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Sì`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Sì`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Sì`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Sì`
`$.oneOf[0].allOf[1].Payload`	`object`	`Sì`
`$.oneOf[0].allOf[1].Payload.checkoutURL`	`string`	`Sì`
`$.oneOf[0].allOf[1].Payload.amountCents`	`integer`	`Sì`
`$.oneOf[0].allOf[1].Payload.expiresAt`	`integer`	`Sì`
`$.oneOf[1]`	`object`	`Sì`
`$.oneOf[1].RequestUserAlias`	`string`	`Sì`
`$.oneOf[1].RequestPath`	`string \| null`	`Sì`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Sì`
`$.oneOf[1].ResponseCode`	`integer`	`Sì`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Sì`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Sì`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Sì`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Sì`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Esempio di risposta

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/bidauction/set_checkout",
    "RequestUserAlias": "example-user",
    "Payload": {
        "checkoutURL": "synthetic-example",
        "amountCents": 0,
        "expiresAt": 0
    }
}

Documentazione dell’endpoint leggibile dalle macchine