AT AppointmentTrader
登录
当前在线  

/v1/partner/

GET

/v1/partner/get_bulk_availability_template

#
Get the CSV columns and example row for bulk venue availability imports.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/partner/get_bulk_availability_template' \
  --data-urlencode 'key={{API_KEY}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_get_bulk_availability_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].Payloadobject 是的
$.oneOf[0].allOf[1].Payload.columnsarray 是的
$.oneOf[0].allOf[1].Payload.columns[]string 否
$.oneOf[0].allOf[1].Payload.examplestring 是的
$.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/partner/get_bulk_availability_template",
    "RequestUserAlias": "example-user",
    "Payload": {
        "columns": [
            "inventory type",
            "date",
            "time/start hour",
            "quantity",
            "price",
            "currency",
            "guest first name",
            "guest last name",
            "contact email",
            "contact phone",
            "category-field JSON",
            "linked post ID"
        ],
        "example": "inventory type,date,time/start hour,quantity,price,currency,guest first name,guest last name,contact email,contact phone,category-field JSON,linked post ID\nSynthetic Dinner Table,2030-07-14,19:00,2,125,USD,Synthetic,Guest,guest@example.com,+1 202 555 0100,\"[]\","
    }
}
机器可读的端点文档
GET

/v1/partner/get_inventory

#
Get location-specific inventory types and linked community posts for a managed venue.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to inspect.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/partner/get_inventory' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_get_inventory_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.InventoryTypesarray 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[]object 否
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Namestring 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Descriptionstring 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].AllowListingsDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].AllowListings.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].AllowListings.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludeGroupNameInLabelTextDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludeGroupNameInLabelText.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludeGroupNameInLabelText.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescription 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescription.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescription.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescriptionHeadline 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescriptionHeadline.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescriptionHeadline.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].PriceIncludesServiceDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].PriceIncludesService.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].PriceIncludesService.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsFallbackOnlyDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsFallbackOnly.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsFallbackOnly.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupNameComp 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupNameComp.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupNameComp.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocationCategory_ShareableWithResourceDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocationCategory_ShareableWithResource.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocationCategory_ShareableWithResource.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyPricenumber 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].DefaultBidAmountnumber 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].DefaultOfferAmountnumber 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsClaimedboolean 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].RawNamestring 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupEntryCountinteger 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupNamestring 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ClaimURLstring 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATLocationInventoryType_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATLocationInventoryType_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATLocationInventoryType_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATDiscussionPosts_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATDiscussionPosts_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATDiscussionPosts_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].PostTitle 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].PostTitle.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].PostTitle.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].URLSlug = "" 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].DefaultBidAmountCentsinteger 是的
$.oneOf[0].allOf[1].Payload.InventoryTypes[].DefaultOfferAmountCentsinteger 是的
$.oneOf[0].allOf[1].Payload.PostLinksarray 是的
$.oneOf[0].allOf[1].Payload.PostLinks[]object 否
$.oneOf[0].allOf[1].Payload.PostLinks[].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.PostLinks[].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.PostLinks[].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.PostLinks[].ATLocationInventoryType_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.PostLinks[].ATLocationInventoryType_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.PostLinks[].ATLocationInventoryType_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.PostLinks[].ATDiscussionPosts_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.PostLinks[].ATDiscussionPosts_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.PostLinks[].ATDiscussionPosts_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.PostLinks[].PostTitle 是的
$.oneOf[0].allOf[1].Payload.PostLinks[].PostTitle.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.PostLinks[].PostTitle.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.PostLinks[].URLSlug = "" 是的
$.oneOf[0].allOf[1].Payload.Schemaobject 是的
$.oneOf[0].allOf[1].Payload.Schema.readyboolean 是的
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray 是的
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]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/partner/get_inventory",
    "RequestUserAlias": "example-user",
    "Payload": {
        "InventoryTypes": [],
        "PostLinks": [],
        "Schema": {
            "ready": false,
            "missingTables": []
        }
    }
}
机器可读的端点文档
GET

/v1/partner/get_listing_regulation_policy

#
Get the venue listing-regulation override policy for a managed venue.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to inspect.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/partner/get_listing_regulation_policy' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_get_listing_regulation_policy_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.policystring ["None","AllowAnyone","CurrentOwnerResellOnly"] 是的
$.oneOf[0].allOf[1].Payload.defaultPolicy = "CurrentOwnerResellOnly" 是的
$.oneOf[0].allOf[1].Payload.canEditboolean 是的
$.oneOf[0].allOf[1].Payload.schemaobject 是的
$.oneOf[0].allOf[1].Payload.schema.readyboolean 是的
$.oneOf[0].allOf[1].Payload.schema.missingColumnsarray 是的
$.oneOf[0].allOf[1].Payload.schema.missingColumns[]string 否
$.oneOf[0].allOf[1].Payload.optionsarray 是的
$.oneOf[0].allOf[1].Payload.options[]object 否
$.oneOf[0].allOf[1].Payload.options[].valuestring ["AllowAnyone","CurrentOwnerResellOnly"] 是的
$.oneOf[0].allOf[1].Payload.options[].labelstring 是的
$.oneOf[0].allOf[1].Payload.restrictedByRegulationboolean 是的
$.oneOf[0].allOf[1].Payload.blockingRegulation 是的
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0].namestring 是的
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0].effectiveDateStartstring 是的
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0].idinteger 是的
$.oneOf[0].allOf[1].Payload.blockingRegulation.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/partner/get_listing_regulation_policy",
    "RequestUserAlias": "example-user",
    "Payload": {
        "policy": "None",
        "defaultPolicy": "CurrentOwnerResellOnly",
        "canEdit": false,
        "schema": {
            "ready": false,
            "missingColumns": []
        },
        "options": [],
        "restrictedByRegulation": false,
        "blockingRegulation": {
            "name": "synthetic-example",
            "effectiveDateStart": "synthetic-example",
            "id": 0
        }
    }
}
机器可读的端点文档
GET

/v1/partner/get_location_claim_options

#
Search venues that can be selected for a partner management claim.

参数

名称类型必填默认值描述
q string 否 "" Search query.
pageSize int 否 15 Maximum options to return.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/partner/get_location_claim_options' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'q={{q}}' \
  --data-urlencode 'pageSize={{pageSize}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_get_location_claim_options_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.querystring 是的
$.oneOf[0].allOf[1].Payload.optionsarray 是的
$.oneOf[0].allOf[1].Payload.options[]object 否
$.oneOf[0].allOf[1].Payload.options[].valuestring 是的
$.oneOf[0].allOf[1].Payload.options[].labelstring 是的
$.oneOf[0].allOf[1].Payload.options[].subtitlestring 是的
$.oneOf[0].allOf[1].Payload.options[].keywordsstring 是的
$.oneOf[0].allOf[1].Payload.options[].aliasstring 是的
$.oneOf[0].allOf[1].Payload.options[].citystring 是的
$.oneOf[0].allOf[1].Payload.options[].countryShortstring 是的
$.oneOf[0].allOf[1].Payload.options[].categoryNamestring 是的
$.oneOf[0].allOf[1].Payload.options[].managementURLstring 是的
$.oneOf[0].allOf[1].Payload.options[].profileURLstring 是的
$.oneOf[0].allOf[1].Payload.options[].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.options[].canManageboolean 是的
$.oneOf[0].allOf[1].Payload.options[].canRequestClaimboolean 是的
$.oneOf[0].allOf[1].Payload.options[].pendingRequest 是的
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0].chatURLstring 是的
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0].requestIDinteger 是的
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0].chatIDinteger 是的
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.schemaobject 是的
$.oneOf[0].allOf[1].Payload.schema.readyboolean 是的
$.oneOf[0].allOf[1].Payload.schema.missingTablesarray 是的
$.oneOf[0].allOf[1].Payload.schema.missingTables[]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/partner/get_location_claim_options",
    "RequestUserAlias": "example-user",
    "Payload": {
        "query": "synthetic-example",
        "options": [],
        "schema": {
            "ready": false,
            "missingTables": []
        }
    }
}
机器可读的端点文档
GET

/v1/partner/get_location_dashboard

#
Get overview demand, listing, sales, and conversion signals for a managed venue.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to inspect.
overviewRange string 否 "30d" Timeframe key: 1d, 7d, 30d, or custom.
overviewFrom string 否 "" Custom range start date when overviewRange is custom.
overviewTo string 否 "" Custom range end date when overviewRange is custom.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/partner/get_location_dashboard' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'overviewRange={{overviewRange}}' \
  --data-urlencode 'overviewFrom={{overviewFrom}}' \
  --data-urlencode 'overviewTo={{overviewTo}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_get_location_dashboard_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.Dashboardobject 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summaryobject 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summary.ViewsDatabaseNumber 否Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views.oneOf[0]number 否
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.Dashboard.summary.BidsDatabaseNumber 否Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids.oneOf[0]number 否
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.Dashboard.summary.ActiveListingsDatabaseNumber 否Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.ActiveListings.oneOf[0]number 否
$.oneOf[0].allOf[1].Payload.Dashboard.summary.ActiveListings.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSalesDatabaseNumber 否Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales.oneOf[0]number 否
$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolumeDatabaseNumber 否Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume.oneOf[0]number 否
$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views30DayDatabaseNumber 是的Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views30Day.oneOf[0]number 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views30Day.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids30DayDatabaseNumber 是的Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids30Day.oneOf[0]number 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids30Day.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales90DayDatabaseNumber 是的Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales90Day.oneOf[0]number 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales90Day.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume90DayDatabaseNumber 是的Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume90Day.oneOf[0]number 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume90Day.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Dashboard.trendarray 是的
$.oneOf[0].allOf[1].Payload.Dashboard.trend[]object 否
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Date 是的
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Date.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Date.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].ViewsDatabaseNumber 是的Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Views.oneOf[0]number 是的
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Views.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].SalesDatabaseNumber 是的Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Sales.oneOf[0]number 是的
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Sales.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].GrossVolumeDatabaseNumber 是的Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].GrossVolume.oneOf[0]number 是的
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].GrossVolume.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypesarray 是的
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[]object 否
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].Namestring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ListingCountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ListingCount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ListingCount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].SalesCountDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].SalesCount.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].SalesCount.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].GrossVolumeDatabaseNumber 是的Numeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].GrossVolume.oneOf[0]number 是的
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].GrossVolume.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormattedobject 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.viewsstring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.bidsstring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.activeListingsstring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.completedSalesstring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.grossVolumestring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.conversionstring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.views30Daystring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.bids30Daystring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.completedSales90Daystring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.grossVolume90Daystring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.timeframeobject 是的
$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.keystring ["1d","7d","30d","custom"] 是的
$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.fromDatestring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.toDatestring 是的
$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.daysinteger 是的
$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.labelstring 是的
$.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/partner/get_location_dashboard",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Dashboard": {
            "summary": {
                "Views30Day": 0,
                "Bids30Day": 0,
                "CompletedSales90Day": 0,
                "GrossVolume90Day": 0
            },
            "trend": [],
            "topInventoryTypes": [],
            "summaryFormatted": {
                "views": "synthetic-example",
                "bids": "synthetic-example",
                "activeListings": "synthetic-example",
                "completedSales": "synthetic-example",
                "grossVolume": "synthetic-example",
                "conversion": "synthetic-example",
                "views30Day": "synthetic-example",
                "bids30Day": "synthetic-example",
                "completedSales90Day": "synthetic-example",
                "grossVolume90Day": "synthetic-example"
            },
            "timeframe": {
                "key": "1d",
                "fromDate": "synthetic-example",
                "toDate": "synthetic-example",
                "days": 0,
                "label": "synthetic-example"
            }
        }
    }
}
机器可读的端点文档
GET

/v1/partner/get_location_inventory_forecast

#
Get a managed venue's inventory forecast using the same market-insight engine as the seller forecast, without public API pricing.

参数

名称类型必填默认值描述
locationID int 否 0 Target location ID.
locationAlias string 否 "" Optional target location alias when locationID is not supplied.
dateRange string 否 "30d" One of 30d, 60d, 90d, custom.
startDate string 否 "" Custom range start date when dateRange=custom, YYYY-MM-DD.
endDate string 否 "" Custom range end date when dateRange=custom, YYYY-MM-DD.
sourceLocationIDs string 否 "" Optional comma-separated similar restaurant location IDs. If empty, saved similar restaurants are used.
sourceLocationAliases string 否 "" Optional comma-separated similar restaurant aliases.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/partner/get_location_inventory_forecast' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'locationAlias={{locationAlias}}' \
  --data-urlencode 'dateRange={{dateRange}}' \
  --data-urlencode 'startDate={{startDate}}' \
  --data-urlencode 'endDate={{endDate}}' \
  --data-urlencode 'sourceLocationIDs={{sourceLocationIDs}}' \
  --data-urlencode 'sourceLocationAliases={{sourceLocationAliases}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_get_location_inventory_forecast_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.locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.sourceLocationIDsarray 是的
$.oneOf[0].allOf[1].Payload.sourceLocationIDs[]integer 否
$.oneOf[0].allOf[1].Payload.forecastobject 是的
$.oneOf[0].allOf[1].Payload.forecast.location 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].locationAliasstring 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].locationNamestring 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].marketLinestring 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].categoryNamestring 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].categoryID 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].categoryID.anyOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].categoryID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocationsarray 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations[]object 否
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations[].locationAliasstring 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations[].locationNamestring 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations[].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceModestring ["likeness","direct"] 是的
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[1]array 是的
$.oneOf[0].allOf[1].Payload.forecast.timeframeobject 是的
$.oneOf[0].allOf[1].Payload.forecast.timeframe.keystring ["30d","60d","90d","custom"] 是的
$.oneOf[0].allOf[1].Payload.forecast.timeframe.daysinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.timeframe.fromstring 是的
$.oneOf[0].allOf[1].Payload.forecast.timeframe.tostring 是的
$.oneOf[0].allOf[1].Payload.forecast.timeframe.fromDatestring 是的
$.oneOf[0].allOf[1].Payload.forecast.timeframe.toDatestring 是的
$.oneOf[0].allOf[1].Payload.forecast.timeframe.labelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.summary 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].rowCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].opportunityRowCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].sourceLocationCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessmentobject 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.labelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.averagePriceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.confidenceLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.recommendedListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.activeListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.neededListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.averagePriceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.recentViewCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.showByDefaultboolean 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.statusstring ["room_for_supply","good_supply","oversupply","no_estimation"] 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.tonestring ["neutral","positive","warning"] 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.confidencestring ["high","medium","developing"] 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.reasonCodesarray 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.reasonCodes[]string ["history","likeness","events","current_demand","popularity","supply","views"] 否
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.reasonLabelsarray 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.reasonLabels[]string 否
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceConfidenceLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceBasisLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.isEstimatedPriceboolean 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceConfidencestring ["high","medium","low","none"] 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceBasisstring ["direct_market","active_supply","related_market","related_country","comparable_sales","none"] 是的
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.comparableSaleCountinteger 否
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.isExactInventoryComparableboolean 否
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.relatedPriceLocationIDinteger 否
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.relatedPriceLocationNamestring 否
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[1]array 是的
$.oneOf[0].allOf[1].Payload.forecast.rowsarray 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[]object 否
$.oneOf[0].allOf[1].Payload.forecast.rows[].inventoryTypeNamestring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].datestring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].dateLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].dateWithDayLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].timeframeLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].averagePriceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].suggestedPriceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].confidenceLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].directAveragePriceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].inventoryTypeIDinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].demandSignalCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].directDemandSignalCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].historyYearCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].activeListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].sellerCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].recommendedListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].neededListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].averagePriceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].suggestedPriceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].popularityTierinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].directAveragePriceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].isLikenessBasedboolean 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].requiresInventoryMappingboolean 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].startHour 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].startHour.anyOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].startHour.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].confidencestring ["high","medium","developing"] 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].evidenceReasonCodesarray 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].evidenceReasonCodes[]string ["history","likeness","supply","popularity"] 否
$.oneOf[0].allOf[1].Payload.forecast.rows[].evidenceLabelsarray 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].evidenceLabels[]string 否
$.oneOf[0].allOf[1].Payload.forecast.rows[].sourceModestring ["direct","likeness","direct+likeness"] 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].sourceLocationIDsarray 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].sourceLocationIDs[]integer 否
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessmentobject 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.labelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.averagePriceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.confidenceLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.recommendedListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.activeListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.neededListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.averagePriceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.recentViewCountinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.showByDefaultboolean 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.statusstring ["room_for_supply","good_supply","oversupply","no_estimation"] 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.tonestring ["neutral","positive","warning"] 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.confidencestring ["high","medium","developing"] 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.reasonCodesarray 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.reasonCodes[]string ["history","likeness","events","current_demand","popularity","supply","views"] 否
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.reasonLabelsarray 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.reasonLabels[]string 否
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceConfidenceLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceBasisLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.isEstimatedPriceboolean 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceConfidencestring ["high","medium","low","none"] 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceBasisstring ["direct_market","active_supply","related_market","related_country","comparable_sales","none"] 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.comparableSaleCountinteger 否
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.isExactInventoryComparableboolean 否
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.relatedPriceLocationIDinteger 否
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.relatedPriceLocationNamestring 否
$.oneOf[0].allOf[1].Payload.forecast.rows[].competitionobject 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.countinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listingsarray 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[]object 否
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingIDstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingURLstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].locationAliasstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].inventoryTypeNamestring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingDatestring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingTimeLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingDateTimeLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].askingPriceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].inventoryTypeIDinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].askingPriceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingViewsOneDayinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingViewsAllTimeinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingPopularityScoreBracketinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].isRequestingUserListingboolean 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingStartHour 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingStartHour.anyOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingStartHour.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].priceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].priceConfidenceLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].priceBasisLabelstring 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].priceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].isEstimatedPriceboolean 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].priceConfidencestring ["high","medium","low","none"] 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].priceBasisstring ["direct_market","active_supply","related_market","related_country","comparable_sales","none"] 是的
$.oneOf[0].allOf[1].Payload.forecast.rows[].comparableSaleCountinteger 否
$.oneOf[0].allOf[1].Payload.forecast.rows[].isExactInventoryComparableboolean 否
$.oneOf[0].allOf[1].Payload.forecast.sourceLocationIDsarray 是的
$.oneOf[0].allOf[1].Payload.forecast.sourceLocationIDs[]integer 否
$.oneOf[0].allOf[1].Payload.location 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].locationAliasstring 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].locationNamestring 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].marketLinestring 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].categoryNamestring 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].categoryID 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].categoryID.anyOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].categoryID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocationsarray 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations[]object 否
$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations[].locationAliasstring 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations[].locationNamestring 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations[].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceModestring ["likeness","direct"] 是的
$.oneOf[0].allOf[1].Payload.location.anyOf[1]array 是的
$.oneOf[0].allOf[1].Payload.timeframeobject 是的
$.oneOf[0].allOf[1].Payload.timeframe.keystring ["30d","60d","90d","custom"] 是的
$.oneOf[0].allOf[1].Payload.timeframe.daysinteger 是的
$.oneOf[0].allOf[1].Payload.timeframe.fromstring 是的
$.oneOf[0].allOf[1].Payload.timeframe.tostring 是的
$.oneOf[0].allOf[1].Payload.timeframe.fromDatestring 是的
$.oneOf[0].allOf[1].Payload.timeframe.toDatestring 是的
$.oneOf[0].allOf[1].Payload.timeframe.labelstring 是的
$.oneOf[0].allOf[1].Payload.summary 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].rowCountinteger 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].opportunityRowCountinteger 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].sourceLocationCountinteger 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessmentobject 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.labelstring 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.averagePriceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.confidenceLabelstring 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.recommendedListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.activeListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.neededListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.averagePriceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.recentViewCountinteger 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.showByDefaultboolean 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.statusstring ["room_for_supply","good_supply","oversupply","no_estimation"] 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.tonestring ["neutral","positive","warning"] 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.confidencestring ["high","medium","developing"] 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.reasonCodesarray 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.reasonCodes[]string ["history","likeness","events","current_demand","popularity","supply","views"] 否
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.reasonLabelsarray 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.reasonLabels[]string 否
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceConfidenceLabelstring 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceBasisLabelstring 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.isEstimatedPriceboolean 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceConfidencestring ["high","medium","low","none"] 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceBasisstring ["direct_market","active_supply","related_market","related_country","comparable_sales","none"] 是的
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.comparableSaleCountinteger 否
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.isExactInventoryComparableboolean 否
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.relatedPriceLocationIDinteger 否
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.relatedPriceLocationNamestring 否
$.oneOf[0].allOf[1].Payload.summary.anyOf[1]array 是的
$.oneOf[0].allOf[1].Payload.rowsarray 是的
$.oneOf[0].allOf[1].Payload.rows[]object 否
$.oneOf[0].allOf[1].Payload.rows[].inventoryTypeNamestring 是的
$.oneOf[0].allOf[1].Payload.rows[].datestring 是的
$.oneOf[0].allOf[1].Payload.rows[].dateLabelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].dateWithDayLabelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].timeframeLabelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].averagePriceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.rows[].suggestedPriceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.rows[].confidenceLabelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].directAveragePriceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.rows[].inventoryTypeIDinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].demandSignalCountinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].directDemandSignalCountinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].historyYearCountinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].activeListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].sellerCountinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].recommendedListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].neededListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].averagePriceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].suggestedPriceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].popularityTierinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].directAveragePriceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].isLikenessBasedboolean 是的
$.oneOf[0].allOf[1].Payload.rows[].requiresInventoryMappingboolean 是的
$.oneOf[0].allOf[1].Payload.rows[].startHour 是的
$.oneOf[0].allOf[1].Payload.rows[].startHour.anyOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.rows[].startHour.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.rows[].confidencestring ["high","medium","developing"] 是的
$.oneOf[0].allOf[1].Payload.rows[].evidenceReasonCodesarray 是的
$.oneOf[0].allOf[1].Payload.rows[].evidenceReasonCodes[]string ["history","likeness","supply","popularity"] 否
$.oneOf[0].allOf[1].Payload.rows[].evidenceLabelsarray 是的
$.oneOf[0].allOf[1].Payload.rows[].evidenceLabels[]string 否
$.oneOf[0].allOf[1].Payload.rows[].sourceModestring ["direct","likeness","direct+likeness"] 是的
$.oneOf[0].allOf[1].Payload.rows[].sourceLocationIDsarray 是的
$.oneOf[0].allOf[1].Payload.rows[].sourceLocationIDs[]integer 否
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessmentobject 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.labelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.averagePriceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.confidenceLabelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.recommendedListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.activeListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.neededListingCountinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.averagePriceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.recentViewCountinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.showByDefaultboolean 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.statusstring ["room_for_supply","good_supply","oversupply","no_estimation"] 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.tonestring ["neutral","positive","warning"] 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.confidencestring ["high","medium","developing"] 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.reasonCodesarray 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.reasonCodes[]string ["history","likeness","events","current_demand","popularity","supply","views"] 否
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.reasonLabelsarray 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.reasonLabels[]string 否
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceConfidenceLabelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceBasisLabelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.isEstimatedPriceboolean 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceConfidencestring ["high","medium","low","none"] 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceBasisstring ["direct_market","active_supply","related_market","related_country","comparable_sales","none"] 是的
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.comparableSaleCountinteger 否
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.isExactInventoryComparableboolean 否
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.relatedPriceLocationIDinteger 否
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.relatedPriceLocationNamestring 否
$.oneOf[0].allOf[1].Payload.rows[].competitionobject 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.countinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listingsarray 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[]object 否
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingIDstring 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingURLstring 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].locationAliasstring 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].inventoryTypeNamestring 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingDatestring 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingTimeLabelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingDateTimeLabelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].askingPriceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].inventoryTypeIDinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].askingPriceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingViewsOneDayinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingViewsAllTimeinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingPopularityScoreBracketinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].isRequestingUserListingboolean 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingStartHour 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingStartHour.anyOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingStartHour.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.rows[].priceFormattedstring 是的
$.oneOf[0].allOf[1].Payload.rows[].priceConfidenceLabelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].priceBasisLabelstring 是的
$.oneOf[0].allOf[1].Payload.rows[].priceCentsinteger 是的
$.oneOf[0].allOf[1].Payload.rows[].isEstimatedPriceboolean 是的
$.oneOf[0].allOf[1].Payload.rows[].priceConfidencestring ["high","medium","low","none"] 是的
$.oneOf[0].allOf[1].Payload.rows[].priceBasisstring ["direct_market","active_supply","related_market","related_country","comparable_sales","none"] 是的
$.oneOf[0].allOf[1].Payload.rows[].comparableSaleCountinteger 否
$.oneOf[0].allOf[1].Payload.rows[].isExactInventoryComparableboolean 否
$.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/partner/get_location_inventory_forecast",
    "RequestUserAlias": "example-user",
    "Payload": {
        "locationID": 0,
        "sourceLocationIDs": [],
        "forecast": {
            "location": {
                "locationAlias": "synthetic-example",
                "locationName": "synthetic-example",
                "marketLine": "synthetic-example",
                "categoryName": "synthetic-example",
                "locationID": 0,
                "categoryID": 0,
                "sourceLocations": [],
                "sourceMode": "likeness"
            },
            "timeframe": {
                "key": "30d",
                "days": 1,
                "from": "synthetic-example",
                "to": "synthetic-example",
                "fromDate": "synthetic-example",
                "toDate": "synthetic-example",
                "label": "synthetic-example"
            },
            "summary": {
                "rowCount": 0,
                "opportunityRowCount": 0,
                "sourceLocationCount": 0,
                "supplyAssessment": {
                    "label": "synthetic-example",
                    "averagePriceFormatted": "synthetic-example",
                    "confidenceLabel": "synthetic-example",
                    "recommendedListingCount": 0,
                    "activeListingCount": 0,
                    "neededListingCount": 0,
                    "averagePriceCents": 0,
                    "recentViewCount": 0,
                    "showByDefault": false,
                    "status": "room_for_supply",
                    "tone": "neutral",
                    "confidence": "high",
                    "reasonCodes": [],
                    "reasonLabels": [],
                    "priceFormatted": "synthetic-example",
                    "priceConfidenceLabel": "synthetic-example",
                    "priceBasisLabel": "synthetic-example",
                    "priceCents": 0,
                    "isEstimatedPrice": false,
                    "priceConfidence": "high",
                    "priceBasis": "direct_market"
                }
            },
            "rows": [],
            "sourceLocationIDs": []
        },
        "location": {
            "locationAlias": "synthetic-example",
            "locationName": "synthetic-example",
            "marketLine": "synthetic-example",
            "categoryName": "synthetic-example",
            "locationID": 0,
            "categoryID": 0,
            "sourceLocations": [],
            "sourceMode": "likeness"
        },
        "timeframe": {
            "key": "30d",
            "days": 1,
            "from": "synthetic-example",
            "to": "synthetic-example",
            "fromDate": "synthetic-example",
            "toDate": "synthetic-example",
            "label": "synthetic-example"
        },
        "summary": {
            "rowCount": 0,
            "opportunityRowCount": 0,
            "sourceLocationCount": 0,
            "supplyAssessment": {
                "label": "synthetic-example",
                "averagePriceFormatted": "synthetic-example",
                "confidenceLabel": "synthetic-example",
                "recommendedListingCount": 0,
                "activeListingCount": 0,
                "neededListingCount": 0,
                "averagePriceCents": 0,
                "recentViewCount": 0,
                "showByDefault": false,
                "status": "room_for_supply",
                "tone": "neutral",
                "confidence": "high",
                "reasonCodes": [],
                "reasonLabels": [],
                "priceFormatted": "synthetic-example",
                "priceConfidenceLabel": "synthetic-example",
                "priceBasisLabel": "synthetic-example",
                "priceCents": 0,
                "isEstimatedPrice": false,
                "priceConfidence": "high",
                "priceBasis": "direct_market"
            }
        },
        "rows": []
    }
}
机器可读的端点文档
GET

/v1/partner/get_location_likeness_group

#
Get saved similar restaurants and suggested related restaurants for a managed venue forecast.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to inspect.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/partner/get_location_likeness_group' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_get_location_likeness_group_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.LocationIDinteger 是的
$.oneOf[0].allOf[1].Payload.Schemaobject 是的
$.oneOf[0].allOf[1].Payload.Schema.readyboolean 是的
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray 是的
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]string 否
$.oneOf[0].allOf[1].Payload.SelectedOptionsarray 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[]object 否
$.oneOf[0].allOf[1].Payload.SelectedOptions[].valuestring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].labelstring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].subtitlestring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].keywordsstring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].aliasstring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].namestring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].cityLinestring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].categoryNamestring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].sourcestring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].relationshipCountinteger 是的
$.oneOf[0].allOf[1].Payload.SelectedLocationIDsarray 是的
$.oneOf[0].allOf[1].Payload.SelectedLocationIDs[]integer 否
$.oneOf[0].allOf[1].Payload.SelectedAliasesarray 是的
$.oneOf[0].allOf[1].Payload.SelectedAliases[]string 否
$.oneOf[0].allOf[1].Payload.SuggestedOptionsarray 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[]object 否
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].valuestring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].labelstring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].subtitlestring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].keywordsstring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].aliasstring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].namestring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].cityLinestring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].categoryNamestring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].sourcestring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].relationshipCountinteger 是的
$.oneOf[0].allOf[1].Payload.CanEditboolean 是的
$.oneOf[0].allOf[1].Payload.CanBulkAvailabilityboolean 是的
$.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/partner/get_location_likeness_group",
    "RequestUserAlias": "example-user",
    "Payload": {
        "LocationID": 0,
        "Schema": {
            "ready": false,
            "missingTables": []
        },
        "SelectedOptions": [],
        "SelectedLocationIDs": [],
        "SelectedAliases": [],
        "SuggestedOptions": [],
        "CanEdit": false,
        "CanBulkAvailability": false
    }
}
机器可读的端点文档
GET

/v1/partner/get_location_likeness_options

#
Search restaurants that can be added to a managed venue's similarity group.

参数

名称类型必填默认值描述
locationID int 是的 — Target location ID.
q string 否 "" Search query.
pageSize int 否 15 Maximum options to return.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/partner/get_location_likeness_options' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'q={{q}}' \
  --data-urlencode 'pageSize={{pageSize}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_get_location_likeness_options_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.optionsarray 是的
$.oneOf[0].allOf[1].Payload.options[]object 否
$.oneOf[0].allOf[1].Payload.options[].valuestring 是的
$.oneOf[0].allOf[1].Payload.options[].labelstring 是的
$.oneOf[0].allOf[1].Payload.options[].subtitlestring 是的
$.oneOf[0].allOf[1].Payload.options[].keywordsstring 是的
$.oneOf[0].allOf[1].Payload.options[].aliasstring 是的
$.oneOf[0].allOf[1].Payload.options[].namestring 是的
$.oneOf[0].allOf[1].Payload.options[].cityLinestring 是的
$.oneOf[0].allOf[1].Payload.options[].categoryNamestring 是的
$.oneOf[0].allOf[1].Payload.options[].sourcestring 是的
$.oneOf[0].allOf[1].Payload.options[].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.options[].relationshipCountinteger 是的
$.oneOf[0].allOf[1].Payload.pageSizeinteger 是的
$.oneOf[0].allOf[1].Payload.querystring 是的
$.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/partner/get_location_likeness_options",
    "RequestUserAlias": "example-user",
    "Payload": {
        "options": [],
        "pageSize": 1,
        "query": "synthetic-example"
    }
}
机器可读的端点文档
GET

/v1/partner/get_location_livestream

#
Get the featured livestream post for a managed venue.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to inspect.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/partner/get_location_livestream' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_get_location_livestream_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.Featured 是的
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postTitlestring 是的
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postURLstring 是的
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].goLiveURLstring 是的
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].liveStreamStartDatestring 是的
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].boardNamestring 是的
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].featuredLivestreamLinkIDinteger 是的
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postIDinteger 是的
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postAuthorUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].isLiveboolean 是的
$.oneOf[0].allOf[1].Payload.Featured.anyOf[1]array 是的
$.oneOf[0].allOf[1].Payload.Schemaobject 是的
$.oneOf[0].allOf[1].Payload.Schema.readyboolean 是的
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray 是的
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]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/partner/get_location_livestream",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Featured": {
            "postTitle": "synthetic-example",
            "postURL": "synthetic-example",
            "goLiveURL": "synthetic-example",
            "liveStreamStartDate": "synthetic-example",
            "boardName": "synthetic-example",
            "featuredLivestreamLinkID": 0,
            "locationID": 0,
            "postID": 0,
            "postAuthorUserID": 0,
            "isLive": false
        },
        "Schema": {
            "ready": false,
            "missingTables": []
        }
    }
}
机器可读的端点文档
GET

/v1/partner/get_locations

#
Get the venue locations this user personally manages through partner team roles or legacy location-user grants, plus their pending venue management applications. Global administrator access alone does not add locations.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/partner/get_locations' \
  --data-urlencode 'key={{API_KEY}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_get_locations_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.schemaobject 是的
$.oneOf[0].allOf[1].Payload.schema.readyboolean 是的
$.oneOf[0].allOf[1].Payload.schema.missingTablesarray 是的
$.oneOf[0].allOf[1].Payload.schema.missingTables[]string 否
$.oneOf[0].allOf[1].Payload.locationsarray 是的
$.oneOf[0].allOf[1].Payload.locations[]object 否
$.oneOf[0].allOf[1].Payload.locations[].namestring 是的
$.oneOf[0].allOf[1].Payload.locations[].aliasstring 是的
$.oneOf[0].allOf[1].Payload.locations[].cityLinestring 是的
$.oneOf[0].allOf[1].Payload.locations[].partnerAccountNamestring 是的
$.oneOf[0].allOf[1].Payload.locations[].rolestring 是的
$.oneOf[0].allOf[1].Payload.locations[].sourcestring 是的
$.oneOf[0].allOf[1].Payload.locations[].managementURLstring 是的
$.oneOf[0].allOf[1].Payload.locations[].profileURLstring 是的
$.oneOf[0].allOf[1].Payload.locations[].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.locations[].partnerAccountID 是的
$.oneOf[0].allOf[1].Payload.locations[].partnerAccountID.anyOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.locations[].partnerAccountID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.pendingRequestsarray 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[]object 否
$.oneOf[0].allOf[1].Payload.pendingRequests[].namestring 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].aliasstring 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].cityLinestring 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].statusstring 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].createdDatestring 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].chatURLstring 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].managementURLstring 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].profileURLstring 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].requestIDinteger 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].chatIDinteger 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationStatusstring 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationChatIDinteger 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationChatURLstring 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationUnreadCount 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationUnreadCount.anyOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationUnreadCount.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].sidebarStatus 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].sidebarStatus.anyOf[0]string ["answer-required","pending"] 是的
$.oneOf[0].allOf[1].Payload.pendingRequests[].sidebarStatus.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/partner/get_locations",
    "RequestUserAlias": "example-user",
    "Payload": {
        "schema": {
            "ready": false,
            "missingTables": []
        },
        "locations": [],
        "pendingRequests": []
    }
}
机器可读的端点文档
GET

/v1/partner/get_opening_hours

#
Get weekly recurring opening-hour windows for a venue the current user may edit.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to inspect.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/partner/get_opening_hours' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_get_opening_hours_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.OpeningHoursobject 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.schemaobject 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.schema.readyboolean 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.schema.missingTablesarray 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.schema.missingTables[]string 否
$.oneOf[0].allOf[1].Payload.OpeningHours.sourcestring ["legacy","split"] 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.maxWindowsPerDay = 4 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.daysarray 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[]object 否
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].keystring 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].labelstring 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].humanReadablestring 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].weekdayinteger 是的Monday=0 through Sunday=6.
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].openTimeinteger 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].closeTimeinteger 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].closedboolean 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windowsarray 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[]object 否Times are integer HHMM; close <= open means the following day.
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].openTimeInputstring 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].closeTimeInputstring 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].labelstring 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].idinteger 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].openTimeinteger 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].closeTimeinteger 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].overnightboolean 是的
$.oneOf[0].allOf[1].Payload.OpeningHours.CanEdit = 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/partner/get_opening_hours",
    "RequestUserAlias": "example-user",
    "Payload": {
        "OpeningHours": {
            "schema": {
                "ready": false,
                "missingTables": []
            },
            "source": "legacy",
            "maxWindowsPerDay": 4,
            "days": [
                {
                    "weekday": 0,
                    "key": "monday",
                    "label": "Monday",
                    "closed": true,
                    "openTime": 0,
                    "closeTime": 0,
                    "humanReadable": "Closed",
                    "windows": []
                },
                {
                    "weekday": 1,
                    "key": "tuesday",
                    "label": "Tuesday",
                    "closed": true,
                    "openTime": 0,
                    "closeTime": 0,
                    "humanReadable": "Closed",
                    "windows": []
                },
                {
                    "weekday": 2,
                    "key": "wednesday",
                    "label": "Wednesday",
                    "closed": true,
                    "openTime": 0,
                    "closeTime": 0,
                    "humanReadable": "Closed",
                    "windows": []
                },
                {
                    "weekday": 3,
                    "key": "thursday",
                    "label": "Thursday",
                    "closed": true,
                    "openTime": 0,
                    "closeTime": 0,
                    "humanReadable": "Closed",
                    "windows": []
                },
                {
                    "weekday": 4,
                    "key": "friday",
                    "label": "Friday",
                    "closed": true,
                    "openTime": 0,
                    "closeTime": 0,
                    "humanReadable": "Closed",
                    "windows": []
                },
                {
                    "weekday": 5,
                    "key": "saturday",
                    "label": "Saturday",
                    "closed": true,
                    "openTime": 0,
                    "closeTime": 0,
                    "humanReadable": "Closed",
                    "windows": []
                },
                {
                    "weekday": 6,
                    "key": "sunday",
                    "label": "Sunday",
                    "closed": true,
                    "openTime": 0,
                    "closeTime": 0,
                    "humanReadable": "Closed",
                    "windows": []
                }
            ],
            "CanEdit": true
        }
    }
}
机器可读的端点文档
GET

/v1/partner/get_team

#
Get active team members, pending invites, and recent partner audit events for a managed venue.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to inspect.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/partner/get_team' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_get_team_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.Teamobject 是的
$.oneOf[0].allOf[1].Payload.Team.partnerAccountIDinteger 否
$.oneOf[0].allOf[1].Payload.Team.membersarray 是的
$.oneOf[0].allOf[1].Payload.Team.members[]object 否
$.oneOf[0].allOf[1].Payload.Team.members[].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.members[].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Team.members[].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Team.members[].ATUser_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.members[].ATUser_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Team.members[].ATUser_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Team.members[].Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] 是的
$.oneOf[0].allOf[1].Payload.Team.members[].Status = "Active" 是的
$.oneOf[0].allOf[1].Payload.Team.members[].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.Team.members[].AcceptedDate 是的
$.oneOf[0].allOf[1].Payload.Team.members[].AcceptedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Team.members[].AcceptedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Team.members[].Aliasstring 是的
$.oneOf[0].allOf[1].Payload.Team.members[].Email 是的
$.oneOf[0].allOf[1].Payload.Team.members[].Email.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Team.members[].Email.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Team.members[].Avatarstring 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].actorUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].targetUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].isBlockedboolean 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].blockedDate 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].blockedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].blockedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].isMutedboolean 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].mutedDate 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].mutedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].mutedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].reasonstring 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].personalNotestring 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[1]object 是的
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[1].personalNote = "" 是的
$.oneOf[0].allOf[1].Payload.Team.invitesarray 是的
$.oneOf[0].allOf[1].Payload.Team.invites[]object 否
$.oneOf[0].allOf[1].Payload.Team.invites[].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.invites[].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].InviteTokenstring 是的Synthetic placeholder in documentation; runtime value is a private team invitation token.
$.oneOf[0].allOf[1].Payload.Team.invites[].Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].InviteEmail 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].InviteEmail.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].InviteEmail.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].Statusstring ["Pending","Accepted","Revoked","Expired"] 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedDate 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].ExpiresDate 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].ExpiresDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].ExpiresDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].CreatedBy-ATUser_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.invites[].CreatedBy-ATUser_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Team.invites[].CreatedBy-ATUser_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Team.auditarray 是的
$.oneOf[0].allOf[1].Payload.Team.audit[]object 否
$.oneOf[0].allOf[1].Payload.Team.audit[].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.audit[].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].Actionstring 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0]string (application/json) 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0]PartnerAuditContext (解码后的 JSON) 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].previousPolicystring ["None","AllowAnyone","CurrentOwnerResellOnly"] 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].policystring ["AllowAnyone","CurrentOwnerResellOnly"] 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].requestIDDatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].requestID.oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].requestID.oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].locationIDsarray 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].locationIDs[]integer 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].countinteger 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].dayCountinteger 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].windowCountinteger 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].reasonstring 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].alreadyDeletedboolean 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummaryobject 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary.penaltyCountinteger 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary.existingPenaltyCountinteger 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary.pointsAmountinteger 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary.currencyAmountinteger 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inventoryTypeIDinteger 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].postIDinteger 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].createdPostboolean 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].rowCountinteger 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].createdCountinteger 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].errorCountinteger 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].appointmentIDsarray 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].appointmentIDs[]integer 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID.anyOf[0]DatabaseInteger 否Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID.anyOf[0].oneOf[0]integer 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID.anyOf[0].oneOf[1]string 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID.anyOf[1]boolean 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].emailstring 否
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[1]array 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ActorAlias 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ActorAlias.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].ActorAlias.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].TargetAlias 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].TargetAlias.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.Team.audit[].TargetAlias.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.Schemaobject 是的
$.oneOf[0].allOf[1].Payload.Schema.readyboolean 是的
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray 是的
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]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/partner/get_team",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Team": {
            "members": [],
            "invites": [],
            "audit": []
        },
        "Schema": {
            "ready": false,
            "missingTables": []
        }
    }
}
机器可读的端点文档
POST

/v1/partner/set_bulk_availability

#
Validate or create bulk dated availability for a managed venue. Created rows become normal ATAppointment listings.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to manage.
csvRows string 是的 — CSV rows using partner/get_bulk_availability_template.
createMissingInventoryTypes bool 否 false Create unknown inventory types before writing rows.
isWritingRequest bool 否 false Dry-run guard for writes.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/partner/set_bulk_availability' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'csvRows={{csvRows}}' \
  --data-urlencode 'createMissingInventoryTypes={{createMissingInventoryTypes}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_set_bulk_availability_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 是的
$.oneOf[0].allOf[1].Payload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rowsarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[]object 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].rowNumberinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].statusstring ["valid","error","created"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].errorsarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].errors[]string 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalizedobject 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.inventoryTypeNamestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.dateTimestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.currencyCodestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.firstNamestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.lastNamestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.emailAddressstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.phoneNumberstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.inventoryTypeIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.quantityinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.priceAmountInSmallestUnitinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.discussionPostIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.createInventoryTypeboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0]array 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][]PartnerImportJSONValue 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4][]PartnerImportJSONValue 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5].*PartnerImportJSONValue 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*PartnerImportJSONValue 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4][]PartnerImportJSONValue 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5].*PartnerImportJSONValue 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].appointmentIDsarray 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].appointmentIDs[]integer 否
$.oneOf[0].allOf[1].Payload.anyOf[0].Summaryobject 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.rowCountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.validCountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.errorCountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.missingInventoryTypesarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.missingInventoryTypes[]string 否
$.oneOf[0].allOf[1].Payload.anyOf[1]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[1]boolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rowsarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[]object 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].rowNumberinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].statusstring ["valid","error","created"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].errorsarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].errors[]string 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalizedobject 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.inventoryTypeNamestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.dateTimestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.currencyCodestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.firstNamestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.lastNamestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.emailAddressstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.phoneNumberstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.inventoryTypeIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.quantityinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.priceAmountInSmallestUnitinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.discussionPostIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.createInventoryTypeboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0]array 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][]PartnerImportJSONValue 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4][]PartnerImportJSONValue 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5].*PartnerImportJSONValue 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*PartnerImportJSONValue 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[0]null 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[1]string 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[2]number 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[3]boolean 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4]array 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4][]PartnerImportJSONValue 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5]object 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5].*PartnerImportJSONValue 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].appointmentIDsarray 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].appointmentIDs[]integer 否
$.oneOf[0].allOf[1].Payload.anyOf[1].Summaryobject 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.rowCountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.createdCountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.errorCountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.appointmentIDsarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.appointmentIDs[]integer 否
$.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/partner/set_bulk_availability",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true,
        "Rows": [],
        "Summary": {
            "rowCount": 0,
            "validCount": 0,
            "errorCount": 0,
            "missingInventoryTypes": []
        }
    }
}
机器可读的端点文档
POST

/v1/partner/set_delete_location

#
Preview or delete a location for failing community standards. Deletion is admin-only and applies new-location reward penalties when applicable.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to delete.
reason string 否 "" Community-standards reason shown in audit and penalty ledger descriptions.
confirmation string 否 "" Type DELETE when isWritingRequest is true.
isWritingRequest bool 否 false False returns a dry-run penalty preview; true soft-deletes and applies penalties.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/partner/set_delete_location' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'reason={{reason}}' \
  --data-urlencode 'confirmation={{confirmation}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_set_delete_location_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 是的
$.oneOf[0].allOf[1].Payload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].AlreadyDeletedboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].LocationIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].LocationNamestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreviewobject 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Succeeded = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.DryRunboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.LocationIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.ProposalCountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summaryobject 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.penaltyCountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.existingPenaltyCountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.pointsAmountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.currencyAmountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penaltiesarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[]object 否
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].rolestring ["submitter","verifier"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].userIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].rewardLedgerIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].confirmationIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].statusstring ["reward-ledger-missing","reward-ledger-user-mismatch","already-penalized","pending","no-penalty-amount","account-missing","penalty-failed","penalized"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].penaltyLedgerIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].pointsAmountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].currencyAmountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].accountIDinteger 否
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].penaltyMultipliernumber 否
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].proposalIDinteger 否
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].locationIDinteger 否
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].locationNamestring 否
$.oneOf[0].allOf[1].Payload.anyOf[1]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].DryRun = false 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].AlreadyDeletedboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].LocationIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].LocationNamestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResultobject 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Succeeded = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.DryRunboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.LocationIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.ProposalCountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summaryobject 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.penaltyCountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.existingPenaltyCountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.pointsAmountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.currencyAmountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penaltiesarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[]object 否
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].rolestring ["submitter","verifier"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].userIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].rewardLedgerIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].confirmationIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].statusstring ["reward-ledger-missing","reward-ledger-user-mismatch","already-penalized","pending","no-penalty-amount","account-missing","penalty-failed","penalized"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].penaltyLedgerIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].pointsAmountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].currencyAmountinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].accountIDinteger 否
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].penaltyMultipliernumber 否
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].proposalIDinteger 否
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].locationIDinteger 否
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].locationNamestring 否
$.oneOf[0].allOf[1].Payload.anyOf[1].RedirectURLstring 是的
$.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/partner/set_delete_location",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true,
        "AlreadyDeleted": false,
        "LocationID": 0,
        "LocationName": "synthetic-example",
        "PenaltyPreview": {
            "Succeeded": true,
            "DryRun": false,
            "LocationID": 0,
            "ProposalCount": 0,
            "Summary": {
                "penaltyCount": 0,
                "existingPenaltyCount": 0,
                "pointsAmount": 0,
                "currencyAmount": 0
            },
            "Penalties": []
        }
    }
}
机器可读的端点文档
POST

/v1/partner/set_inventory_type

#
Create or update a location-specific inventory type for a managed venue.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to manage.
inventoryTypeID int 否 0 Existing inventory type ID, or 0 to create one.
name string 否 "" Inventory type name.
description string 否 "" Short description.
allowListings bool 否 true Whether sellers can create listings for this type.
groupName string 否 "" Optional group label.
headcount int 否 0 Optional default headcount.
defaultBidAmount int 否 0 Default bid amount in cents.
defaultOfferAmount int 否 0 Default offer amount in cents.
isWritingRequest bool 否 false Dry-run guard for writes.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/partner/set_inventory_type' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'inventoryTypeID={{inventoryTypeID}}' \
  --data-urlencode 'name={{name}}' \
  --data-urlencode 'description={{description}}' \
  --data-urlencode 'allowListings={{allowListings}}' \
  --data-urlencode 'groupName={{groupName}}' \
  --data-urlencode 'headcount={{headcount}}' \
  --data-urlencode 'defaultBidAmount={{defaultBidAmount}}' \
  --data-urlencode 'defaultOfferAmount={{defaultOfferAmount}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_set_inventory_type_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 是的
$.oneOf[0].allOf[1].Payload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[1]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].InventoryTypeIDinteger 是的
$.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/partner/set_inventory_type",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}
机器可读的端点文档
POST

/v1/partner/set_inventory_type_post_link

#
Link a community post to a venue inventory type.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to manage.
inventoryTypeID int 是的 — Inventory type ID.
discussionPostID int 是的 — Community post ID to link.
isWritingRequest bool 否 false Dry-run guard for writes.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/partner/set_inventory_type_post_link' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'inventoryTypeID={{inventoryTypeID}}' \
  --data-urlencode 'discussionPostID={{discussionPostID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_set_inventory_type_post_link_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 是的
$.oneOf[0].allOf[1].Payload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[1]array 是的
$.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/partner/set_inventory_type_post_link",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}
机器可读的端点文档
POST

/v1/partner/set_listing_regulation_policy

#
Save the venue listing-regulation override policy. Only venue Owners/Admins, legacy venue managers, and global community administrators may save.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to manage.
policy string 是的 — One of AllowAnyone or CurrentOwnerResellOnly.
isWritingRequest bool 否 false Dry-run guard for writes.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/partner/set_listing_regulation_policy' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'policy={{policy}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_set_listing_regulation_policy_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 是的
$.oneOf[0].allOf[1].Payload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].policystring ["AllowAnyone","CurrentOwnerResellOnly"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[1]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].policystring ["None","AllowAnyone","CurrentOwnerResellOnly"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].defaultPolicy = "CurrentOwnerResellOnly" 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].canEditboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].schemaobject 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].schema.readyboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].schema.missingColumnsarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].schema.missingColumns[]string 否
$.oneOf[0].allOf[1].Payload.anyOf[1].optionsarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].options[]object 否
$.oneOf[0].allOf[1].Payload.anyOf[1].options[].valuestring ["AllowAnyone","CurrentOwnerResellOnly"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].options[].labelstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].restrictedByRegulationboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0].namestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0].effectiveDateStartstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0].idinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Saved = 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/partner/set_listing_regulation_policy",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true,
        "policy": "AllowAnyone"
    }
}
机器可读的端点文档
POST

/v1/partner/set_location_claim_request

#
Request management access to a location. The request is sent to GlobalCommunityAdministration users in a chat with approve/reject action buttons.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to claim.
message string 否 "" Optional claim note for reviewers.
isWritingRequest bool 否 false Dry-run guard for writes.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/partner/set_location_claim_request' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'message={{message}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_set_location_claim_request_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 是的
$.oneOf[0].allOf[1].Payload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].AlreadyManager = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].ManagementURLstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].ChatURLstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].RequestIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].ChatIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Createdboolean 是的
$.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/partner/set_location_claim_request",
    "RequestUserAlias": "example-user",
    "Payload": {
        "AlreadyManager": true,
        "ManagementURL": "synthetic-example"
    }
}
机器可读的端点文档
POST

/v1/partner/set_location_likeness_group

#
Save the managed venue's similarity group used by partner inventory forecasts.

参数

名称类型必填默认值描述
locationID int 是的 — Target location ID.
locationIDs string 否 "" Comma-separated similar restaurant location IDs.
isWritingRequest bool 否 false Dry-run guard for writes.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/partner/set_location_likeness_group' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'locationIDs={{locationIDs}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_set_location_likeness_group_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.LocationIDinteger 是的
$.oneOf[0].allOf[1].Payload.Schemaobject 是的
$.oneOf[0].allOf[1].Payload.Schema.readyboolean 是的
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray 是的
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]string 否
$.oneOf[0].allOf[1].Payload.SelectedOptionsarray 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[]object 否
$.oneOf[0].allOf[1].Payload.SelectedOptions[].valuestring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].labelstring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].subtitlestring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].keywordsstring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].aliasstring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].namestring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].cityLinestring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].categoryNamestring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].sourcestring 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.SelectedOptions[].relationshipCountinteger 是的
$.oneOf[0].allOf[1].Payload.SelectedLocationIDsarray 是的
$.oneOf[0].allOf[1].Payload.SelectedLocationIDs[]integer 否
$.oneOf[0].allOf[1].Payload.SelectedAliasesarray 是的
$.oneOf[0].allOf[1].Payload.SelectedAliases[]string 否
$.oneOf[0].allOf[1].Payload.SuggestedOptionsarray 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[]object 否
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].valuestring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].labelstring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].subtitlestring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].keywordsstring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].aliasstring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].namestring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].cityLinestring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].categoryNamestring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].sourcestring 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].relationshipCountinteger 是的
$.oneOf[0].allOf[1].Payload.CanEditboolean 是的
$.oneOf[0].allOf[1].Payload.CanBulkAvailabilityboolean 是的
$.oneOf[0].allOf[1].Payload.SavedCountinteger 是的
$.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/partner/set_location_likeness_group",
    "RequestUserAlias": "example-user",
    "Payload": {
        "LocationID": 0,
        "Schema": {
            "ready": false,
            "missingTables": []
        },
        "SelectedOptions": [],
        "SelectedLocationIDs": [],
        "SelectedAliases": [],
        "SuggestedOptions": [],
        "CanEdit": false,
        "CanBulkAvailability": false,
        "SavedCount": 0
    }
}
机器可读的端点文档
POST

/v1/partner/set_location_livestream_post

#
Feature a location-connected community post as the venue livestream station, or create a new station post and feature it.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to manage.
discussionPostID int 否 0 Existing public top-level location post to feature. Use 0 when createPost is true.
title string 否 "" Optional title for a newly created station post.
body string 否 "" Optional body for a newly created station post.
createPost bool 否 false Create a new location discussion post before featuring it.
clear bool 否 false Remove the featured livestream post from the public location page.
isWritingRequest bool 否 false Dry-run guard for writes.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/partner/set_location_livestream_post' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'discussionPostID={{discussionPostID}}' \
  --data-urlencode 'title={{title}}' \
  --data-urlencode 'body={{body}}' \
  --data-urlencode 'createPost={{createPost}}' \
  --data-urlencode 'clear={{clear}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_set_location_livestream_post_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 是的
$.oneOf[0].allOf[1].Payload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Featuredarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[1]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].DiscussionPostIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postTitlestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postURLstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].goLiveURLstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].liveStreamStartDatestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].boardNamestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].featuredLivestreamLinkIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].locationIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postAuthorUserIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].isLiveboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[1]array 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].PostURLstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].GoLiveURLstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[2]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].DryRun = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].WouldCreatePost = true 否
$.oneOf[0].allOf[1].Payload.anyOf[2].DiscussionPostIDinteger 否
$.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/partner/set_location_livestream_post",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Featured": []
    }
}
机器可读的端点文档
POST

/v1/partner/set_opening_hours

#
Validate or save weekly recurring split opening hours for a managed venue.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to manage.
hoursJSON string 否 "" JSON payload with days, closed flags, and open/close windows.
isWritingRequest bool 否 false Dry-run guard for writes.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/partner/set_opening_hours' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'hoursJSON={{hoursJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
参数: hoursJSON
字段类型必填描述
hoursJSONstring (application/json) 否
hoursJSONPartnerOpeningHoursInput (解码后的 JSON) 否Omitted weekdays are closed. A non-closed day needs 1–4 non-overlapping windows; weekday may be explicit or the zero-based list/key index.
hoursJSON.anyOf[0]object 否
hoursJSON.anyOf[0].days 是的
hoursJSON.anyOf[0].days.anyOf[0]array 是的
hoursJSON.anyOf[0].days.anyOf[0][]object 否
hoursJSON.anyOf[0].days.anyOf[0][].weekdayinteger 否
hoursJSON.anyOf[0].days.anyOf[0][].closedboolean 否
hoursJSON.anyOf[0].days.anyOf[0][].windowsarray 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[]object 否Supply one opening and one closing alias. They must differ; overnight windows are supported. Windows cannot overlap or repeat.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTime 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTime.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].open 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].open.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].open.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].OpenTime 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].OpenTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].OpenTime.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTimeInput 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTimeInput.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTimeInput.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTime 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTime.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].close 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].close.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].close.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].CloseTime 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].CloseTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].CloseTime.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTimeInput 否
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTimeInput.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTimeInput.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[1]object 是的
hoursJSON.anyOf[0].days.anyOf[1].*object 否
hoursJSON.anyOf[0].days.anyOf[1].*.weekdayinteger 否
hoursJSON.anyOf[0].days.anyOf[1].*.closedboolean 否
hoursJSON.anyOf[0].days.anyOf[1].*.windowsarray 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[]object 否Supply one opening and one closing alias. They must differ; overnight windows are supported. Windows cannot overlap or repeat.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTime 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTime.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].open 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].open.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].open.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].OpenTime 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].OpenTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].OpenTime.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTimeInput 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTimeInput.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTimeInput.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTime 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTime.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].close 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].close.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].close.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].CloseTime 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].CloseTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].CloseTime.anyOf[1]integer 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTimeInput 否
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTimeInput.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTimeInput.anyOf[1]integer 否
hoursJSON.anyOf[1] 否
hoursJSON.anyOf[1].anyOf[0]array 否
hoursJSON.anyOf[1].anyOf[0][]object 否
hoursJSON.anyOf[1].anyOf[0][].weekdayinteger 否
hoursJSON.anyOf[1].anyOf[0][].closedboolean 否
hoursJSON.anyOf[1].anyOf[0][].windowsarray 否
hoursJSON.anyOf[1].anyOf[0][].windows[]object 否Supply one opening and one closing alias. They must differ; overnight windows are supported. Windows cannot overlap or repeat.
hoursJSON.anyOf[1].anyOf[0][].windows[].openTime 否
hoursJSON.anyOf[1].anyOf[0][].windows[].openTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].openTime.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[0][].windows[].open 否
hoursJSON.anyOf[1].anyOf[0][].windows[].open.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].open.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[0][].windows[].OpenTime 否
hoursJSON.anyOf[1].anyOf[0][].windows[].OpenTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].OpenTime.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[0][].windows[].openTimeInput 否
hoursJSON.anyOf[1].anyOf[0][].windows[].openTimeInput.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].openTimeInput.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTime 否
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTime.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[0][].windows[].close 否
hoursJSON.anyOf[1].anyOf[0][].windows[].close.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].close.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[0][].windows[].CloseTime 否
hoursJSON.anyOf[1].anyOf[0][].windows[].CloseTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].CloseTime.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTimeInput 否
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTimeInput.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTimeInput.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[1]object 否
hoursJSON.anyOf[1].anyOf[1].*object 否
hoursJSON.anyOf[1].anyOf[1].*.weekdayinteger 否
hoursJSON.anyOf[1].anyOf[1].*.closedboolean 否
hoursJSON.anyOf[1].anyOf[1].*.windowsarray 否
hoursJSON.anyOf[1].anyOf[1].*.windows[]object 否Supply one opening and one closing alias. They must differ; overnight windows are supported. Windows cannot overlap or repeat.
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTime 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTime.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].open 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].open.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].open.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].OpenTime 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].OpenTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].OpenTime.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTimeInput 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTimeInput.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTimeInput.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTime 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTime.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].close 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].close.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].close.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].CloseTime 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].CloseTime.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].CloseTime.anyOf[1]integer 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTimeInput 否
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTimeInput.anyOf[0]string 否HH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTimeInput.anyOf[1]integer 否
响应字段
字段类型必填描述
$partner_set_opening_hours_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 是的
$.oneOf[0].allOf[1].Payload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].daysarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[]object 否
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].keystring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].labelstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].humanReadablestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].weekdayinteger 是的Monday=0 through Sunday=6.
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].openTimeinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].closeTimeinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].closedboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windowsarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[]object 否Times are integer HHMM; close <= open means the following day.
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].openTimeInputstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].closeTimeInputstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].labelstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].idinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].openTimeinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].closeTimeinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].overnightboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].rowsarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[]object 否
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].Weekdayinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].OpenTimeinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].CloseTimeinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].SortOrderinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHoursobject 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schemaobject 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema.readyboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema.missingTablesarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema.missingTables[]string 否
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.sourcestring ["legacy","split"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.maxWindowsPerDay = 4 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.daysarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[]object 否
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].keystring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].labelstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].humanReadablestring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].weekdayinteger 是的Monday=0 through Sunday=6.
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].openTimeinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].closeTimeinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].closedboolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windowsarray 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[]object 否Times are integer HHMM; close <= open means the following day.
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].openTimeInputstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].closeTimeInputstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].labelstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].idinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].openTimeinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].closeTimeinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].overnightboolean 是的
$.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/partner/set_opening_hours",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true,
        "days": [
            {
                "weekday": 0,
                "key": "monday",
                "label": "Monday",
                "closed": true,
                "openTime": 0,
                "closeTime": 0,
                "humanReadable": "Closed",
                "windows": []
            },
            {
                "weekday": 1,
                "key": "tuesday",
                "label": "Tuesday",
                "closed": true,
                "openTime": 0,
                "closeTime": 0,
                "humanReadable": "Closed",
                "windows": []
            },
            {
                "weekday": 2,
                "key": "wednesday",
                "label": "Wednesday",
                "closed": true,
                "openTime": 0,
                "closeTime": 0,
                "humanReadable": "Closed",
                "windows": []
            },
            {
                "weekday": 3,
                "key": "thursday",
                "label": "Thursday",
                "closed": true,
                "openTime": 0,
                "closeTime": 0,
                "humanReadable": "Closed",
                "windows": []
            },
            {
                "weekday": 4,
                "key": "friday",
                "label": "Friday",
                "closed": true,
                "openTime": 0,
                "closeTime": 0,
                "humanReadable": "Closed",
                "windows": []
            },
            {
                "weekday": 5,
                "key": "saturday",
                "label": "Saturday",
                "closed": true,
                "openTime": 0,
                "closeTime": 0,
                "humanReadable": "Closed",
                "windows": []
            },
            {
                "weekday": 6,
                "key": "sunday",
                "label": "Sunday",
                "closed": true,
                "openTime": 0,
                "closeTime": 0,
                "humanReadable": "Closed",
                "windows": []
            }
        ],
        "rows": []
    }
}
机器可读的端点文档
POST

/v1/partner/set_team_invite

#
Create or accept a role-scoped venue team invite. Creating an invite preserves normal referral attribution through the returned URL's v parameter.

参数

名称类型必填默认值描述
locationID int 否 0 Location ID for the invite.
role string 否 "Analyst" One of Owner, Admin, InventoryManager, HostSupport, Finance, Analyst.
email string 否 "" Optional invite email annotation.
inviteToken string 否 "" Existing invite token to accept instead of creating a new invite.
acceptInvite bool 否 false Accept inviteToken for the signed-in user.
isWritingRequest bool 否 false Dry-run guard for writes.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/partner/set_team_invite' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'role={{role}}' \
  --data-urlencode 'email={{email}}' \
  --data-urlencode 'inviteToken={{inviteToken}}' \
  --data-urlencode 'acceptInvite={{acceptInvite}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_set_team_invite_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 是的
$.oneOf[0].allOf[1].Payload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[1]boolean 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteURLstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[1]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].DryRun = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].InviteURLstring 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[2]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Inviteobject 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATPartnerAccount_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATPartnerAccount_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATPartnerAccount_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteTokenstring 是的Synthetic placeholder in documentation; runtime value is a private team invitation token.
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteEmail 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteEmail.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteEmail.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.Status = "Pending" 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.CreatedBy-ATUser_IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.CreatedBy-ATUser_ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.CreatedBy-ATUser_ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedDate 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ExpiresDate 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ExpiresDate.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ExpiresDate.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.anyOf[2].DryRun = 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/partner/set_team_invite",
    "RequestUserAlias": "example-user",
    "Payload": {
        "InviteID": 0,
        "InviteURL": "synthetic-example",
        "Role": "Owner"
    }
}
机器可读的端点文档
POST

/v1/partner/set_team_member_remove

#
Remove a user from a venue team.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to manage.
userID int 是的 — Team member user ID to remove.
isWritingRequest bool 否 false Dry-run guard for writes.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/partner/set_team_member_remove' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'userID={{userID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_set_team_member_remove_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 是的
$.oneOf[0].allOf[1].Payload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[1]array 是的
$.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/partner/set_team_member_remove",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}
机器可读的端点文档
POST

/v1/partner/set_team_member_role

#
Add an existing user to a venue team or change that user's partner role.

参数

名称类型必填默认值描述
locationID int 是的 — Location ID to manage.
aliasOrEmail string 是的 — Existing user's alias or email.
role string 是的 — One of Owner, Admin, InventoryManager, HostSupport, Finance, Analyst.
isWritingRequest bool 否 false Dry-run guard for writes.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/partner/set_team_member_role' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'aliasOrEmail={{aliasOrEmail}}' \
  --data-urlencode 'role={{role}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$partner_set_team_member_role_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 是的
$.oneOf[0].allOf[1].Payload.anyOf[0]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true 是的
$.oneOf[0].allOf[1].Payload.anyOf[1]object 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].UserIDinteger 是的
$.oneOf[0].allOf[1].Payload.anyOf[1].Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] 是的
$.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/partner/set_team_member_role",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}
机器可读的端点文档