AT AppointmentTrader
Войти
Сейчас онлайн  

/v1/listing/

Manages portfolio related functions such as price changes and status changes
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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.Name = "Competing Listings" Да
$.oneOf[0].allOf[1].Payload.MetaInformationobject Да
$.oneOf[0].allOf[1].Payload.MetaInformation.ListingCountinteger Да
$.oneOf[0].allOf[1].Payload.KeyValueListarray Да
$.oneOf[0].allOf[1].Payload.KeyValueList[]object Нет
$.oneOf[0].allOf[1].Payload.KeyValueList[].listingIDstring Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].locationAliasstring Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].inventoryTypeNamestring Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].listingDatestring Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].listingDetailStatementstring Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].listingRespondByTimestring Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].inventoryTypeIDinteger Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].listingCurrentAskingPriceinteger Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].listingViewsOneDayinteger Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].listingViewsAllTimeinteger Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].listingPopularityScoreBracketinteger Да
$.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[].isRequestingUserListingboolean Да
$.oneOf[0].allOf[1].Payload.KeyValueFieldListarray Да
$.oneOf[0].allOf[1].Payload.KeyValueFieldList[]string Нет
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.viewersarray Да
$.oneOf[0].allOf[1].Payload.viewers[]object Нет
$.oneOf[0].allOf[1].Payload.viewers[].userIDinteger Да
$.oneOf[0].allOf[1].Payload.viewers[].aliasstring Да
$.oneOf[0].allOf[1].Payload.viewers[].avatarEmojistring Да
$.oneOf[0].allOf[1].Payload.viewers[].lastViewedAtstring Да
$.oneOf[0].allOf[1].Payload.totalinteger Да
$.oneOf[0].allOf[1].Payload.pageinteger Да
$.oneOf[0].allOf[1].Payload.hasMoreboolean Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.Name = "Portfolio Listing Items" Да
$.oneOf[0].allOf[1].Payload.MetaInformation = [] Да
$.oneOf[0].allOf[1].Payload.KeyValueListarray Да
$.oneOf[0].allOf[1].Payload.KeyValueList[]object Нет
$.oneOf[0].allOf[1].Payload.KeyValueList[].Namestring ["AppointmentDrafts","ApprovedAppointments","PrivateAppointments","UnlockedAppointments","SubmittedListings_Rejections","SubmittedListings_InReview","SubmittedListings_WaitingForReview"] Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].MetaInformationobject Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].MetaInformation.ListingCountinteger Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueListarray Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[]object Нет
$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingIDstring | null Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationAliasstring Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationIDDatabaseInteger Да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[].inventoryTypeIDDatabaseInteger Да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[].listingDatestring Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingTimestring Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingStartHourDatabaseInteger Да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[].listingCurrentAskingPriceDatabaseInteger Да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[].listingDetailStatementstring Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingStatusstring Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingPublicConfirmationNumberstring Да
$.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[].listingViewsOneDayDatabaseInteger Нет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[].listingViewsAllTimeDatabaseInteger Нет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[].KeyValueFieldListarray Да
$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueFieldList[]string Нет
$.oneOf[0].allOf[1].Payload.KeyValueFieldList = [] Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.listingIDstring Да
$.oneOf[0].allOf[1].Payload.currencyCode = "USD" Да
$.oneOf[0].allOf[1].Payload.originalPriceCentsinteger Да
$.oneOf[0].allOf[1].Payload.discountCentsinteger Да
$.oneOf[0].allOf[1].Payload.buyerPriceCentsinteger Да
$.oneOf[0].allOf[1].Payload.feeCentsinteger Да
$.oneOf[0].allOf[1].Payload.sellerProceedsCentsinteger Да
$.oneOf[0].allOf[1].Payload.recipientCountinteger Да
$.oneOf[0].allOf[1].Payload.expiresAtstring Да
$.oneOf[0].allOf[1].Payload.expiresAtISOstring Да
$.oneOf[0].allOf[1].Payload.previewTokenstring Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.offerIDinteger Да
$.oneOf[0].allOf[1].Payload.countsobject Да
$.oneOf[0].allOf[1].Payload.counts.queuedinteger Да
$.oneOf[0].allOf[1].Payload.counts.sentinteger Да
$.oneOf[0].allOf[1].Payload.counts.skippedinteger Да
$.oneOf[0].allOf[1].Payload.counts.failedinteger Да
$.oneOf[0].allOf[1].Payload.expiresAtstring Да
$.oneOf[0].allOf[1].Payload.activeboolean Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payload = true Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.success = true Да
$.oneOf[0].allOf[1].Payload.messagestring Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payload = true Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.success = true Да
$.oneOf[0].allOf[1].Payload.messagestring Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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
ПолеТипОбязательноОписание
dynamicFieldsJsonstring (application/json) Нет
dynamicFieldsJsonobject (декодированный JSON) Нет
dynamicFieldsJson.*string Нет
Поля ответа
ПолеТипОбязательноОписание
$listing_set_complete_transfer_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.success = true Да
$.oneOf[0].allOf[1].Payload.messagestring Да
$.oneOf[0].allOf[1].Payload.currencyReceivednumber Да
$.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].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadstring ДаUUID of the resulting listing.
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.listingIDstring Да
$.oneOf[0].allOf[1].Payload.status = "deleted" Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.success = true Да
$.oneOf[0].allOf[1].Payload.messagestring Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadstring ДаUUID of the resulting listing.
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payload = true Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payload = true Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payload = true Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.offerIDinteger Да
$.oneOf[0].allOf[1].Payload.countsobject Да
$.oneOf[0].allOf[1].Payload.counts.queuedinteger Да
$.oneOf[0].allOf[1].Payload.counts.sentinteger Да
$.oneOf[0].allOf[1].Payload.counts.skippedinteger Да
$.oneOf[0].allOf[1].Payload.counts.failedinteger Да
$.oneOf[0].allOf[1].Payload.expiresAtstring Да
$.oneOf[0].allOf[1].Payload.activeboolean Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.listingIDstring Да
$.oneOf[0].allOf[1].Payload.statusstring ["Approved","Private","Unlocked","Transfer Failed But Unlocked"] Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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://ru.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
ПолеТипОбязательноОписание
locationCategoryFieldIDValueListstring (application/json) ДаPass a JSON-encoded string, not nested form fields.
locationCategoryFieldIDValueListarray (декодированный JSON) Да
locationCategoryFieldIDValueList[] Нет
locationCategoryFieldIDValueList[].oneOf[0]object Нет
locationCategoryFieldIDValueList[].oneOf[0].fieldIDinteger Да
locationCategoryFieldIDValueList[].oneOf[0].fieldValuestring Да
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].Valuestring Да
Поля ответа
ПолеТипОбязательноОписание
$listing_set_update_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.listingIDstring Да
$.oneOf[0].allOf[1].Payload.appointmentIDinteger Да
$.oneOf[0].allOf[1].Payload.statusstring Да
$.oneOf[0].allOf[1].Payload.locationNamestring Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.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].RequestImpersonatedByUserAliasstring Нет
Пример ответа 
{
    "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"
    }
}
Машиночитаемая документация метода