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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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"
    }
}
機械可読のエンドポイントドキュメント