/v1/auction/get_bid_status
#المعلمات
| الاسم | النوع | مطلوب | الافتراضي | الوصف |
|---|---|---|---|---|
bidID |
int |
نعم |
— |
Auction bid ID returned by /v1/auction/set_bid_checkout. |
مثال طلب (cURL)
curl --get \
'https://ar.appointmenttrader.com/v1/auction/get_bid_status' \
--data-urlencode 'key={{API_KEY}}' \
--data-urlencode 'bidID={{bidID}}'
القيمة المُرجعة
JSON حقول الاستجابة
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
$ | auction_get_bid_status_Response |
نعم | |
$.oneOf[0] | |
نعم | |
$.oneOf[0].allOf[0] | object |
نعم | |
$.oneOf[0].allOf[0].RequestUserAlias | string |
نعم | |
$.oneOf[0].allOf[0].RequestPath | string | null |
نعم | |
$.oneOf[0].allOf[0].RequestStatus | = "Succeeded" |
نعم | |
$.oneOf[0].allOf[0].ResponseCode | integer |
نعم | |
$.oneOf[0].allOf[0].ResponseMessage | APIResponseMessage |
نعم | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0] | string | number | boolean | null |
نعم | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1] | array |
نعم | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][] | APIResponseMessage |
لا | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2] | object |
نعم | |
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].* | APIResponseMessage |
لا | |
$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias | string |
لا | |
$.oneOf[0].allOf[1] | object |
نعم | |
$.oneOf[0].allOf[1].Payload | object |
نعم | |
$.oneOf[0].allOf[1].Payload.bidID | integer |
نعم | |
$.oneOf[0].allOf[1].Payload.listingID | string |
نعم | |
$.oneOf[0].allOf[1].Payload.amountCents | integer |
نعم | |
$.oneOf[0].allOf[1].Payload.status | string ["PendingFunding","Leading","Outbid","Won","Returned"] |
نعم | |
$.oneOf[0].allOf[1].Payload.buyerIdentityHidden | boolean |
لا | Response projection adds this flag when a bid context is present; true hides the buyer while any of their qualifying response races is open. |
$.oneOf[0].allOf[1].Payload.buyerIdentityHiddenUntil | integer | null |
لا | Latest saved closing timestamp among the buyer's qualifying open response races, in Unix seconds, or null when identity is visible. |
$.oneOf[1] | object |
نعم | |
$.oneOf[1].RequestUserAlias | string |
نعم | |
$.oneOf[1].RequestPath | string | null |
نعم | |
$.oneOf[1].RequestStatus | = "Failed" |
نعم | |
$.oneOf[1].ResponseCode | integer |
نعم | |
$.oneOf[1].ResponseMessage | APIResponseMessage |
نعم | |
$.oneOf[1].ResponseMessage.oneOf[0] | string | number | boolean | null |
نعم | |
$.oneOf[1].ResponseMessage.oneOf[1] | array |
نعم | |
$.oneOf[1].ResponseMessage.oneOf[1][] | APIResponseMessage |
لا | |
$.oneOf[1].ResponseMessage.oneOf[2] | object |
نعم | |
$.oneOf[1].ResponseMessage.oneOf[2].* | APIResponseMessage |
لا | |
$.oneOf[1].RequestImpersonatedByUserAlias | string |
لا |
مثال استجابة
{
"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"
}
}