מדריך API של listing | AppointmentTrader

GET

/v1/listing/get_competing_listings

#

Lists competing listings in a certain timeframe, along with pricing information

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	unique listing IDs to provide competing listing information for which can be retrieved by /v1/listing/get_portfolio_listings or when creating a new listing with /v1/location/set_listing

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

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

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_get_competing_listings_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.Name`	`= "Competing Listings"`	`כן`
`$.oneOf[0].allOf[1].Payload.MetaInformation`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.MetaInformation.ListingCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingID`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].locationAlias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].inventoryTypeName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingDate`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingDetailStatement`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingRespondByTime`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].inventoryTypeID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingCurrentAskingPrice`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingViewsOneDay`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingViewsAllTime`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingPopularityScoreBracket`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingStartHour`		`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingStartHour.anyOf[0]`		`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingStartHour.anyOf[0].anyOf[0]`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingStartHour.anyOf[0].anyOf[1]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].listingStartHour.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].isRequestingUserListing`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueFieldList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueFieldList[]`	`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/listing/get_competing_listings",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Name": "Competing Listings",
        "MetaInformation": {
            "ListingCount": 0
        },
        "KeyValueList": [],
        "KeyValueFieldList": []
    }
}

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

GET

/v1/listing/get_discount_viewers

#

List eligible signed-in viewers from the last 30 days. Only the current listing owner may read this audience.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	Listing UUID.
`searchText`	`string`	`לא`	`""`	Optional alias search.
`page`	`int`	`לא`	`1`	One-based page; 50 viewers per page.

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

curl --get \
  'https://he.appointmenttrader.com/v1/listing/get_discount_viewers' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'searchText={{searchText}}' \
  --data-urlencode 'page={{page}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_get_discount_viewers_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.viewers`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.viewers[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.viewers[].userID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.viewers[].alias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.viewers[].avatarEmoji`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.viewers[].lastViewedAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.total`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.page`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.hasMore`	`boolean`	`כן`
`$.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/listing/get_discount_viewers",
    "RequestUserAlias": "example-user",
    "Payload": {
        "viewers": [],
        "total": 0,
        "page": 0,
        "hasMore": false
    }
}

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

GET

/v1/listing/get_portfolio_listings

#

Legacy alias for /v1/portfolio/get_listings

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`getPopularityScoreBracket`	`bool`	`לא`	`false`	if true, the popularity score for all listings will be returned

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

curl --get \
  'https://he.appointmenttrader.com/v1/listing/get_portfolio_listings' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'getPopularityScoreBracket={{getPopularityScoreBracket}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה	תיאור
`$`	`listing_get_portfolio_listings_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.Name`	`= "Portfolio Listing Items"`	`כן`
`$.oneOf[0].allOf[1].Payload.MetaInformation`	`= []`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].Name`	`string ["AppointmentDrafts","ApprovedAppointments","PrivateAppointments","UnlockedAppointments","SubmittedListings_Rejections","SubmittedListings_InReview","SubmittedListings_WaitingForReview"]`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].MetaInformation`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].MetaInformation.ListingCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingID`	`string \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationAlias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationID`	`DatabaseInteger`	`כן`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationID.oneOf[0]`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationID.oneOf[1]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingRespondByTime`		`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingRespondByTime.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingRespondByTime.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationCitySlug`		`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationCitySlug.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationCitySlug.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].creatorUserAlias`		`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].creatorUserAlias.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].creatorUserAlias.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].inventoryTypeID`	`DatabaseInteger`	`כן`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].inventoryTypeID.oneOf[0]`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].inventoryTypeID.oneOf[1]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].inventoryTypeName`		`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].inventoryTypeName.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].inventoryTypeName.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingDate`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingTime`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingStartHour`	`DatabaseInteger`	`כן`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingStartHour.oneOf[0]`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingStartHour.oneOf[1]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingCurrentAskingPrice`	`DatabaseInteger`	`כן`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingCurrentAskingPrice.oneOf[0]`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingCurrentAskingPrice.oneOf[1]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].bid-communityPostID`		`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].bid-communityPostID.anyOf[0]`	`DatabaseInteger`	`כן`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].bid-communityPostID.anyOf[0].oneOf[0]`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].bid-communityPostID.anyOf[0].oneOf[1]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].bid-communityPostID.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingDetailStatement`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingStatus`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingPublicConfirmationNumber`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].orderListID`		`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].orderListID.anyOf[0]`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].orderListID.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingPopularityScoreBracket`		`לא`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingPopularityScoreBracket.anyOf[0]`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingPopularityScoreBracket.anyOf[1]`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingPopularityScoreBracket.anyOf[2]`	`null`	`לא`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingViewsOneDay`	`DatabaseInteger`	`לא`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingViewsOneDay.oneOf[0]`	`integer`	`לא`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingViewsOneDay.oneOf[1]`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingViewsAllTime`	`DatabaseInteger`	`לא`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingViewsAllTime.oneOf[0]`	`integer`	`לא`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingViewsAllTime.oneOf[1]`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueFieldList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueFieldList[]`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.KeyValueFieldList`	`= []`	`כן`
`$.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/listing/get_portfolio_listings",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Name": "Portfolio Listing Items",
        "MetaInformation": [],
        "KeyValueList": [],
        "KeyValueFieldList": []
    }
}

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

GET

/v1/listing/get_viewer_discount_preview

#

Preview a seller-funded fixed-amount offer. Public price stays unchanged; fees use the discounted price.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	Listing UUID.
`discountAmountInSmallestUnit`	`int`	`כן`	`—`	Positive USD cents.
`currencyCode`	`string`	`לא`	`"USD"`	Listing discount currency; USD.
`durationHours`	`int`	`לא`	`24`	One of 1, 6, 24, 48, capped by listing expiry.
`allViewers`	`bool`	`לא`	`true`	Include all eligible viewers across every page.
`recipientUserIDList`	`string`	`לא`	`""`	Comma-separated selected IDs when allViewers is false.

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

curl --get \
  'https://he.appointmenttrader.com/v1/listing/get_viewer_discount_preview' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'discountAmountInSmallestUnit={{discountAmountInSmallestUnit}}' \
  --data-urlencode 'currencyCode={{currencyCode}}' \
  --data-urlencode 'durationHours={{durationHours}}' \
  --data-urlencode 'allViewers={{allViewers}}' \
  --data-urlencode 'recipientUserIDList={{recipientUserIDList}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_get_viewer_discount_preview_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.currencyCode`	`= "USD"`	`כן`
`$.oneOf[0].allOf[1].Payload.originalPriceCents`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.discountCents`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.buyerPriceCents`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.feeCents`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.sellerProceedsCents`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.recipientCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.expiresAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.expiresAtISO`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.previewToken`	`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/listing/get_viewer_discount_preview",
    "RequestUserAlias": "example-user",
    "Payload": {
        "listingID": "synthetic-example",
        "currencyCode": "USD",
        "originalPriceCents": 0,
        "discountCents": 0,
        "buyerPriceCents": 0,
        "feeCents": 0,
        "sellerProceedsCents": 0,
        "recipientCount": 0,
        "expiresAt": "synthetic-example",
        "expiresAtISO": "synthetic-example",
        "previewToken": "synthetic-example"
    }
}

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

GET

/v1/listing/get_viewer_discount_status

#

Read delivery progress for an offer belonging to the current listing owner.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	Listing UUID.
`offerID`	`int`	`כן`	`—`	Offer returned by /v1/listing/set_send_viewer_discount.

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

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

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_get_viewer_discount_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.offerID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.counts`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.counts.queued`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.counts.sent`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.counts.skipped`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.counts.failed`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.expiresAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.active`	`boolean`	`כן`
`$.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/listing/get_viewer_discount_status",
    "RequestUserAlias": "example-user",
    "Payload": {
        "offerID": 0,
        "counts": {
            "queued": 0,
            "sent": 0,
            "skipped": 0,
            "failed": 0
        },
        "expiresAt": "synthetic-example",
        "active": false
    }
}

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

POST

/v1/listing/set_archive

#

Archive Listing

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingUUID`	`string`	`כן`	`—`	Unique listing ID that can be retrieved by /v1/listing/get_portfolio_listings or /v1/location/set_listing
`isWritingRequest`	`bool`	`לא`	`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

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_archive' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingUUID={{listingUUID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_archive_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/listing/set_archive",
    "RequestUserAlias": "example-user",
    "Payload": true
}

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

POST

/v1/listing/set_begin_transfer

#

Start working on a transfer-service listing.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	unique listing ID that can be retrieved by /v1/listing/get_portfolio_listings
`isWritingRequest`	`bool`	`לא`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data

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

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

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_begin_transfer_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.success`	`= true`	`כן`
`$.oneOf[0].allOf[1].Payload.message`	`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/listing/set_begin_transfer",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "message": "synthetic-example"
    }
}

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

POST

/v1/listing/set_cancel_bid

#

Cancels a bid

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`bidID`	`int`	`כן`	`—`	unique bid ID
`isWritingRequest`	`bool`	`לא`	`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

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_cancel_bid' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_cancel_bid_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/listing/set_cancel_bid",
    "RequestUserAlias": "example-user",
    "Payload": true
}

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

POST

/v1/listing/set_cancel_transfer_service

#

Cancel transfer service for a seller-owned listing.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	unique listing ID that can be retrieved by /v1/listing/get_portfolio_listings
`isWritingRequest`	`bool`	`לא`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data

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

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

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_cancel_transfer_service_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.success`	`= true`	`כן`
`$.oneOf[0].allOf[1].Payload.message`	`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/listing/set_cancel_transfer_service",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "message": "synthetic-example"
    }
}

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

POST

/v1/listing/set_complete_transfer

#

Mark a transfer-service listing as successfully transferred.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	unique listing ID that can be retrieved by /v1/listing/get_portfolio_listings
`givenName`	`string`	`כן`	`—`	first name now on the reservation
`familyName`	`string`	`כן`	`—`	last name now on the reservation
`dynamicFieldsJson`	`string`	`לא`	`""`	optional JSON object of location field id to value
`isWritingRequest`	`bool`	`לא`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_complete_transfer' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'givenName={{givenName}}' \
  --data-urlencode 'familyName={{familyName}}' \
  --data-urlencode 'dynamicFieldsJson={{dynamicFieldsJson}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

פרמטרים: dynamicFieldsJson

שדה	סוג	חובה
`dynamicFieldsJson`	`string (application/json)`	`לא`
`dynamicFieldsJson`	`object (JSON מפוענח)`	`לא`
`dynamicFieldsJson.*`	`string`	`לא`

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_complete_transfer_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.success`	`= true`	`כן`
`$.oneOf[0].allOf[1].Payload.message`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.currencyReceived`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.newBalance`		`כן`
`$.oneOf[0].allOf[1].Payload.newBalance.anyOf[0]`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.newBalance.anyOf[1]`	`null`	`כן`
`$.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/listing/set_complete_transfer",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "message": "synthetic-example",
        "currencyReceived": 0,
        "newBalance": 0
    }
}

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

POST

/v1/listing/set_create_from_template

#

Creates an appointment from a template, only appointments owned by api user may be copied. With publishListing and discardTemplateListing true, a locked Private reservation is relisted in place at the selected price in unrestricted markets only. Owner, permission, listing-limit, future-date, and refund/no-show checks still apply. An Approved original may be retried without duplicating the reservation or status history.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`templateListingID`	`string`	`כן`	`—`	unique listing ID which can be retrieved by /v1/listing/get_portfolio_listings or when creating a new listing with /v1/location/set_listing
`publishListing`	`bool`	`לא`	`false`	if true, the listing will be published to the market, if false it will be taken private
`bidID`	`int`	`לא`	`-1`	optional matching bid to fill when publishListing is true; -1 leaves the listing unlinked
`discardTemplateListing`	`bool`	`לא`	`false`	archive the original after copying; with publishListing true, Private and Approved originals are updated in place instead
`priceAmountInSmallestUnit`	`int`	`לא`	`-1`	optional asking price for the relisted or copied listing in the smallest currency unit; rounded to USD 5 steps within the configured minimum and USD 10000 maximum
`isWritingRequest`	`bool`	`לא`	`false`	false (default) prevents writes; set true to publish or copy the listing

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_create_from_template' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'templateListingID={{templateListingID}}' \
  --data-urlencode 'publishListing={{publishListing}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'discardTemplateListing={{discardTemplateListing}}' \
  --data-urlencode 'priceAmountInSmallestUnit={{priceAmountInSmallestUnit}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה	תיאור
`$`	`listing_set_create_from_template_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`	`string`	`כן`	UUID of the resulting listing.
`$.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/listing/set_create_from_template",
    "RequestUserAlias": "example-user",
    "Payload": "synthetic-example"
}

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

POST

/v1/listing/set_delete_review

#

Take a listing out of review and delete it.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingUUID`	`string`	`כן`	`—`	Unique listing ID that can be retrieved by /v1/listing/get_portfolio_listings or /v1/location/set_listing
`isWritingRequest`	`bool`	`לא`	`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

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_delete_review' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingUUID={{listingUUID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_delete_review_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.status`	`= "deleted"`	`כן`
`$.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/listing/set_delete_review",
    "RequestUserAlias": "example-user",
    "Payload": {
        "listingID": "synthetic-example",
        "status": "deleted"
    }
}

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

POST

/v1/listing/set_fail_transfer

#

Mark a transfer-service listing as failed.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	unique listing ID that can be retrieved by /v1/listing/get_portfolio_listings
`failedOption`	`string`	`כן`	`—`	Unlock if the buyer can still use the listing, Failed otherwise
`reason`	`string`	`כן`	`—`	transfer failure note
`isWritingRequest`	`bool`	`לא`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_fail_transfer' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'failedOption={{failedOption}}' \
  --data-urlencode 'reason={{reason}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_fail_transfer_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.success`	`= true`	`כן`
`$.oneOf[0].allOf[1].Payload.message`	`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/listing/set_fail_transfer",
    "RequestUserAlias": "example-user",
    "Payload": {
        "success": true,
        "message": "synthetic-example"
    }
}

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

POST

/v1/listing/set_fill_bid

#

Fills a bid with a portfolio bid answer that is either off market or publicly available to fill a bid with a new bid answer please use /v1/location/set_listing An ordinary pickup requiring an auction returns auctionRequired and auctionURL instead of filling. Ready inventory must win the auction first; the winner can attach this listing to their awarded hold. Available normal bids also accept complete inventory without FillBids or a prior hold, after response selection finishes. A submitted listing claims the bid for review; approved inventory completes the fill. Buyer-selected, unexpired direct hires also accept Premium confirmations without FillBids or HoldPremiumBids. This grants no pickup or round access.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	unique listing ID which can be retrieved by /v1/listing/get_portfolio_listings or when creating a new listing with /v1/location/set_listing
`bidID`	`int`	`כן`	`—`	Requested bid. Complete inventory must match its accepted terms and seller-selection policy.
`isWritingRequest`	`bool`	`לא`	`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
`outsideRequestedTimeframeAcknowledged`	`bool`	`לא`	`false`	Set true only after the concierge accepts the held answer's out-of-timeframe warning. Recorded against this answer and current bid terms for completion or later review; does not waive non-time requirements or direct-fill matching.
`selfReviewConfirmed`	`bool`	`לא`	`false`	Explicit final confirmation for eligible self-review of an unapproved confirmation; defaults to false.

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_fill_bid' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}' \
  --data-urlencode 'outsideRequestedTimeframeAcknowledged={{outsideRequestedTimeframeAcknowledged}}' \
  --data-urlencode 'selfReviewConfirmed={{selfReviewConfirmed}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה	תיאור
`$`	`listing_set_fill_bid_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`	`string`	`כן`	UUID of the resulting listing.
`$.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/listing/set_fill_bid",
    "RequestUserAlias": "example-user",
    "Payload": "synthetic-example"
}

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

POST

/v1/listing/set_market_visibility

#

Changes the visibility in the market. In the portal private listings appear in the private section and public in 'Publicly traded listings'

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	unique listing ID which can be retrieved by /v1/listing/get_portfolio_listings or when creating a new listing with /v1/location/set_listing
`publishListing`	`bool`	`כן`	`—`	if true, the listing will be published to the market, if false it will be taken private
`isWritingRequest`	`bool`	`לא`	`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

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_market_visibility' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'publishListing={{publishListing}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_market_visibility_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/listing/set_market_visibility",
    "RequestUserAlias": "example-user",
    "Payload": true
}

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

POST

/v1/listing/set_price

#

Changes the current listing price

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	unique listing ID which can be retrieved by /v1/listing/get_portfolio_listings or when creating a new listing with /v1/location/set_listing
`priceAmountInSmallestUnit`	`int`	`כן`	`—`	Smallest possible currency unit, for example USD 100 would be 10000 (usd-cents), amounts will be rounded to next 5 increment. Refer to the MetaInformation of the return object of /v1/location/get_comparable_trades for pricing information. Endpoint will also return if there is an available bid - if available bid price is matched in your upload, bid will automatically be filled.
`isWritingRequest`	`bool`	`לא`	`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

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_price' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'priceAmountInSmallestUnit={{priceAmountInSmallestUnit}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_price_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/listing/set_price",
    "RequestUserAlias": "example-user",
    "Payload": true
}

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

POST

/v1/listing/set_purchase

#

Purchase a listing

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`fundingAccountID`	`int`	`כן`	`—`	ID of the account that will fund the bid, accountIDs can be found in /v1/account/get_list
`listingID`	`string`	`כן`	`—`	the unique listing ID that shall be purchased
`orderListID`	`string`	`לא`	`""`	If this bid is part of an orderList, set the ID here.
`isWritingRequest`	`bool`	`לא`	`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

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_purchase' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'fundingAccountID={{fundingAccountID}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'orderListID={{orderListID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_purchase_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/listing/set_purchase",
    "RequestUserAlias": "example-user",
    "Payload": true
}

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

POST

/v1/listing/set_send_viewer_discount

#

Send one private offer per viewer per listing through normal notifications. Reuse requestID for uncertain retries.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	Listing UUID.
`discountAmountInSmallestUnit`	`int`	`כן`	`—`	Fixed discount in USD cents.
`previewToken`	`string`	`כן`	`—`	Unchanged token from /v1/listing/get_viewer_discount_preview.
`requestID`	`string`	`כן`	`—`	Unique request identifier, 16-64 letters/digits/hyphens. Reusing it with different parameters fails.
`currencyCode`	`string`	`לא`	`"USD"`	USD.
`durationHours`	`int`	`לא`	`24`	1, 6, 24 or 48.
`allViewers`	`bool`	`לא`	`true`	Send to all eligible viewers, not just the visible page.
`recipientUserIDList`	`string`	`לא`	`""`	Comma-separated selected user IDs when allViewers is false.
`isWritingRequest`	`bool`	`לא`	`false`	Must be true to queue notifications.

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_send_viewer_discount' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'discountAmountInSmallestUnit={{discountAmountInSmallestUnit}}' \
  --data-urlencode 'previewToken={{previewToken}}' \
  --data-urlencode 'requestID={{requestID}}' \
  --data-urlencode 'currencyCode={{currencyCode}}' \
  --data-urlencode 'durationHours={{durationHours}}' \
  --data-urlencode 'allViewers={{allViewers}}' \
  --data-urlencode 'recipientUserIDList={{recipientUserIDList}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_send_viewer_discount_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.offerID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.counts`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.counts.queued`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.counts.sent`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.counts.skipped`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.counts.failed`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.expiresAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.active`	`boolean`	`כן`
`$.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/listing/set_send_viewer_discount",
    "RequestUserAlias": "example-user",
    "Payload": {
        "offerID": 0,
        "counts": {
            "queued": 0,
            "sent": 0,
            "skipped": 0,
            "failed": 0
        },
        "expiresAt": "synthetic-example",
        "active": false
    }
}

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

POST

/v1/listing/set_unarchive

#

Restore an archived listing to its previous market visibility.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingUUID`	`string`	`כן`	`—`	Unique listing ID that can be retrieved by /v1/listing/get_portfolio_listings or /v1/location/set_listing
`isWritingRequest`	`bool`	`לא`	`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

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_unarchive' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingUUID={{listingUUID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_unarchive_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.status`	`string ["Approved","Private","Unlocked","Transfer Failed But Unlocked"]`	`כן`
`$.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/listing/set_unarchive",
    "RequestUserAlias": "example-user",
    "Payload": {
        "listingID": "synthetic-example",
        "status": "Approved"
    }
}

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

POST

/v1/listing/set_update

#

Updates an off-market seller listing using the same structured listing fields as the v2 listing composer.

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`listingID`	`string`	`כן`	`—`	unique listing ID which can be retrieved by /v1/listing/get_portfolio_listings or when creating a new listing with /v1/location/set_listing
`locationAlias`	`string`	`כן`	`—`	Slug found after the slash when opening a location in the portal
`inventoryTypeID`	`int`	`כן`	`—`	inventoryTypeID found in /v1/location/get_inventory_types
`priceAmountInSmallestUnit`	`int`	`כן`	`—`	Smallest possible currency unit, for example USD 100 would be 10000 (usd-cents).
`currencyCode`	`string`	`כן`	`—`	3 digit currency code, currently all prices will be converted to USD and rounded
`dateTime`	`string`	`כן`	`—`	Date and Time of listing. Date format: YYYY-MM-DD HH:MM:SS
`firstName`	`string`	`כן`	`—`	First name of listing
`lastName`	`string`	`כן`	`—`	Last name of listing
`emailAddress`	`string`	`כן`	`—`	Email address associated with the listing
`phoneNumber`	`string`	`כן`	`—`	Phone number associated with the listing
`locationCategoryFieldIDValueList`	`array`	`כן`	`—`	Refer to /v1/location/get_category to identify the required and optional field list for the location you are submitting for.
`isWritingRequest`	`bool`	`לא`	`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
`resubmitRejectedListing`	`bool`	`לא`	`false`	Set true when fixing a rejected listing and resubmitting it for review.

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

curl --request POST \
  'https://he.appointmenttrader.com/v1/listing/set_update' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'locationAlias={{locationAlias}}' \
  --data-urlencode 'inventoryTypeID={{inventoryTypeID}}' \
  --data-urlencode 'priceAmountInSmallestUnit={{priceAmountInSmallestUnit}}' \
  --data-urlencode 'currencyCode={{currencyCode}}' \
  --data-urlencode 'dateTime={{dateTime}}' \
  --data-urlencode 'firstName={{firstName}}' \
  --data-urlencode 'lastName={{lastName}}' \
  --data-urlencode 'emailAddress={{emailAddress}}' \
  --data-urlencode 'phoneNumber={{phoneNumber}}' \
  --data-urlencode 'locationCategoryFieldIDValueList={{locationCategoryFieldIDValueList}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}' \
  --data-urlencode 'resubmitRejectedListing={{resubmitRejectedListing}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

פרמטרים: locationCategoryFieldIDValueList

שדה	סוג	חובה	תיאור
`locationCategoryFieldIDValueList`	`string (application/json)`	`כן`	Pass a JSON-encoded string, not nested form fields.
`locationCategoryFieldIDValueList`	`array (JSON מפוענח)`	`כן`
`locationCategoryFieldIDValueList[]`		`לא`
`locationCategoryFieldIDValueList[].oneOf[0]`	`object`	`לא`
`locationCategoryFieldIDValueList[].oneOf[0].fieldID`	`integer`	`כן`
`locationCategoryFieldIDValueList[].oneOf[0].fieldValue`	`string`	`כן`
`locationCategoryFieldIDValueList[].oneOf[1]`	`object`	`לא`
`locationCategoryFieldIDValueList[].oneOf[1].ID`		`כן`
`locationCategoryFieldIDValueList[].oneOf[1].ID.anyOf[0]`	`integer`	`כן`
`locationCategoryFieldIDValueList[].oneOf[1].ID.anyOf[1]`	`string`	`כן`
`locationCategoryFieldIDValueList[].oneOf[1].Value`	`string`	`כן`

שדות התגובה

שדה	סוג	חובה
`$`	`listing_set_update_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.appointmentID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.status`	`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/listing/set_update",
    "RequestUserAlias": "example-user",
    "Payload": {
        "listingID": "synthetic-example",
        "appointmentID": 0,
        "status": "synthetic-example",
        "locationName": "synthetic-example"
    }
}

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