현재 온라인  

/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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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://kr.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"
    }
}
기계가 읽을 수 있는 엔드포인트 문서