מדריך API של auction | AppointmentTrader

חיפוש בכל נקודות הקצה

/v1/auction/

GET

/v1/auction/get_bid_status

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

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`bidID`	`int`	`כן`	`—`	Auction bid ID returned by /v1/auction/set_bid_checkout.

דוגמת בקשה (cURL)

curl --get \
  'https://he.appointmenttrader.com/v1/auction/get_bid_status' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה	תיאור
`$`	`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"
    }
}

תיעוד נקודת קצה קריא למכונה

GET

/v1/auction/get_detail

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

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	Listing UUID.

דוגמת בקשה (cURL)

curl --get \
  'https://he.appointmenttrader.com/v1/auction/get_detail' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`auction_get_detail_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.listingID`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locationName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.imageUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.inventoryTypeName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.timezone`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.statusLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cardPriceLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cardSummary`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.url`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.auctionID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.startingPriceCents`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.currentBidCents`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.minimumNextBidCents`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.bidCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.revision`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.isOpen`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.isLeading`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.canAdministrativelyCancel`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.canBid`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.canManage`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.isSeller`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.listingStart`		`כן`
`$.oneOf[0].allOf[1].Payload.listingStart.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.listingStart.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.serverTime`		`כן`
`$.oneOf[0].allOf[1].Payload.serverTime.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.serverTime.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.endsAt`		`כן`
`$.oneOf[0].allOf[1].Payload.endsAt.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.endsAt.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.purchaseURL`		`כן`
`$.oneOf[0].allOf[1].Payload.purchaseURL.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.purchaseURL.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.saleMode`	`string ["FixedPrice","Auction"]`	`כן`
`$.oneOf[0].allOf[1].Payload.status`	`string ["PendingApproval","Open","Settling","Sold","Unsold","Cancelled"]`	`כן`
`$.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_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"
    }
}

תיעוד נקודת קצה קריא למכונה

GET

/v1/auction/get_my_bids

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`pageNumber`	`int`	`לא`	`1`	One-based page number.
`activeOnly`	`bool`	`לא`	`false`	Only the latest participation per open or settling auction.

דוגמת בקשה (cURL)

curl --get \
  'https://he.appointmenttrader.com/v1/auction/get_my_bids' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageNumber={{pageNumber}}' \
  --data-urlencode 'activeOnly={{activeOnly}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה	תיאור
`$`	`auction_get_my_bids_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`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload[].ID`	`DatabaseInteger`	`כן`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].ID.oneOf[0]`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload[].ID.oneOf[1]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload[].ATListingAuctions_ID`	`DatabaseInteger`	`כן`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].ATListingAuctions_ID.oneOf[0]`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload[].ATListingAuctions_ID.oneOf[1]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload[].AmountCents`	`DatabaseInteger`	`כן`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].AmountCents.oneOf[0]`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload[].AmountCents.oneOf[1]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload[].Status`	`string ["Leading","Outbid","Won","Returned"]`	`כן`
`$.oneOf[0].allOf[1].Payload[].ReturnLedger_ID`		`כן`
`$.oneOf[0].allOf[1].Payload[].ReturnLedger_ID.anyOf[0]`	`DatabaseInteger`	`כן`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].ReturnLedger_ID.anyOf[0].oneOf[0]`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload[].ReturnLedger_ID.anyOf[0].oneOf[1]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload[].ReturnLedger_ID.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload[].ATAppointment_ID`	`DatabaseInteger`	`כן`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload[].ATAppointment_ID.oneOf[0]`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload[].ATAppointment_ID.oneOf[1]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload[].AuctionStatus`	`string ["PendingApproval","Open","Settling","Sold","Unsold","Cancelled"]`	`כן`
`$.oneOf[0].allOf[1].Payload[].EndsAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload[].ListingUUID`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload[].LocationName`	`string`	`כן`
`$.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_my_bids",
    "RequestUserAlias": "example-user",
    "Payload": []
}

תיעוד נקודת קצה קריא למכונה

POST

/v1/auction/set_bid_checkout

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

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	Listing UUID.
`amountCents`	`int`	`כן`	`—`	Bid in USD cents.
`requestID`	`string`	`כן`	`—`	Unique 16-64 character retry identifier.
`isWritingRequest`	`bool`	`לא`	`false`	Explicit writing guard.

דוגמת בקשה (cURL)

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

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה	תיאור
`$`	`auction_set_bid_checkout_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.checkoutURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.bidID`	`integer`	`כן`
`$.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/set_bid_checkout",
    "RequestUserAlias": "example-user",
    "Payload": {
        "checkoutURL": "/modules/bid/bid.php?customarticle=auctionbid&parameters=FAKE_CHECKOUT_TOKEN&donotapply&inline",
        "bidID": 1001
    }
}

תיעוד נקודת קצה קריא למכונה

POST

/v1/auction/set_cancel

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

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	Listing UUID.
`administrative`	`bool`	`לא`	`false`	Requires listing approval permission.
`isWritingRequest`	`bool`	`לא`	`false`	Explicit writing guard.

דוגמת בקשה (cURL)

curl --request POST \
  'https://he.appointmenttrader.com/v1/auction/set_cancel' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'administrative={{administrative}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`auction_set_cancel_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`	`= true`	`כן`
`$.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/set_cancel",
    "RequestUserAlias": "example-user",
    "Payload": true
}

תיעוד נקודת קצה קריא למכונה

POST

/v1/auction/set_save

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

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	Listing UUID.
`startingPriceCents`	`int`	`כן`	`—`	Starting price in USD cents.
`endsAt`	`string`	`לא`	`""`	ISO timestamp with offset, or venue-local date and time. Empty defaults to 24 hours capped at listing start.
`saleMode`	`string`	`לא`	`"Auction"`	Auction or FixedPrice.
`isWritingRequest`	`bool`	`לא`	`false`	Explicit writing guard.

דוגמת בקשה (cURL)

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

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`auction_set_save_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.listingID`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locationName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.imageUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.inventoryTypeName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.timezone`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.statusLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cardPriceLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cardSummary`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.url`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.auctionID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.startingPriceCents`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.currentBidCents`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.minimumNextBidCents`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.bidCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.revision`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.isOpen`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.isLeading`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.canAdministrativelyCancel`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.canBid`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.canManage`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.isSeller`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.listingStart`		`כן`
`$.oneOf[0].allOf[1].Payload.listingStart.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.listingStart.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.serverTime`		`כן`
`$.oneOf[0].allOf[1].Payload.serverTime.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.serverTime.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.endsAt`		`כן`
`$.oneOf[0].allOf[1].Payload.endsAt.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.endsAt.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.purchaseURL`		`כן`
`$.oneOf[0].allOf[1].Payload.purchaseURL.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.purchaseURL.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.saleMode`	`string ["FixedPrice","Auction"]`	`כן`
`$.oneOf[0].allOf[1].Payload.status`	`string ["PendingApproval","Open","Settling","Sold","Unsold","Cancelled"]`	`כן`
`$.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/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"
    }
}

תיעוד נקודת קצה קריא למכונה