AT AppointmentTrader
Accedi
Online ora  

/v1/partner/

GET

/v1/partner/get_bulk_availability_template

#
Get the CSV columns and example row for bulk venue availability imports.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.appointmenttrader.com/v1/partner/get_bulk_availability_template' \
  --data-urlencode 'key={{API_KEY}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_get_bulk_availability_template_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.columnsarray Sì
$.oneOf[0].allOf[1].Payload.columns[]string No
$.oneOf[0].allOf[1].Payload.examplestring Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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,\"[]\","
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/partner/get_inventory

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to inspect.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.appointmenttrader.com/v1/partner/get_inventory' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_get_inventory_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.InventoryTypesarray Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[]object No
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IDDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ID.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Namestring Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID.anyOf[0]DatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID.anyOf[0]DatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Descriptionstring Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].AllowListingsDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].AllowListings.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].AllowListings.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludeGroupNameInLabelTextDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludeGroupNameInLabelText.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludeGroupNameInLabelText.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescription Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescription.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescription.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescriptionHeadline Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescriptionHeadline.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescriptionHeadline.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].PriceIncludesServiceDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].PriceIncludesService.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].PriceIncludesService.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsFallbackOnlyDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsFallbackOnly.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsFallbackOnly.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupNameComp Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupNameComp.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupNameComp.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocationCategory_ShareableWithResourceDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocationCategory_ShareableWithResource.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocationCategory_ShareableWithResource.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyPricenumber Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].DefaultBidAmountnumber Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].DefaultOfferAmountnumber Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsClaimedboolean Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].RawNamestring Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupEntryCountinteger Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupNamestring Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].ClaimURLstring Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].IDDatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATLocationInventoryType_IDDatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATLocationInventoryType_ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATDiscussionPosts_IDDatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATDiscussionPosts_ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].PostTitle Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].PostTitle.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].PostTitle.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].URLSlug = "" Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].DefaultBidAmountCentsinteger Sì
$.oneOf[0].allOf[1].Payload.InventoryTypes[].DefaultOfferAmountCentsinteger Sì
$.oneOf[0].allOf[1].Payload.PostLinksarray Sì
$.oneOf[0].allOf[1].Payload.PostLinks[]object No
$.oneOf[0].allOf[1].Payload.PostLinks[].IDDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.PostLinks[].ID.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.PostLinks[].ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.PostLinks[].ATLocationInventoryType_IDDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.PostLinks[].ATLocationInventoryType_ID.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.PostLinks[].ATLocationInventoryType_ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.PostLinks[].ATDiscussionPosts_IDDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.PostLinks[].ATDiscussionPosts_ID.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.PostLinks[].ATDiscussionPosts_ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.PostLinks[].PostTitle Sì
$.oneOf[0].allOf[1].Payload.PostLinks[].PostTitle.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.PostLinks[].PostTitle.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.PostLinks[].URLSlug = "" Sì
$.oneOf[0].allOf[1].Payload.Schemaobject Sì
$.oneOf[0].allOf[1].Payload.Schema.readyboolean Sì
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray Sì
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]string No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/get_inventory",
    "RequestUserAlias": "example-user",
    "Payload": {
        "InventoryTypes": [],
        "PostLinks": [],
        "Schema": {
            "ready": false,
            "missingTables": []
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/partner/get_listing_regulation_policy

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to inspect.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.appointmenttrader.com/v1/partner/get_listing_regulation_policy' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_get_listing_regulation_policy_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.policystring ["None","AllowAnyone","CurrentOwnerResellOnly"] Sì
$.oneOf[0].allOf[1].Payload.defaultPolicy = "CurrentOwnerResellOnly" Sì
$.oneOf[0].allOf[1].Payload.canEditboolean Sì
$.oneOf[0].allOf[1].Payload.schemaobject Sì
$.oneOf[0].allOf[1].Payload.schema.readyboolean Sì
$.oneOf[0].allOf[1].Payload.schema.missingColumnsarray Sì
$.oneOf[0].allOf[1].Payload.schema.missingColumns[]string No
$.oneOf[0].allOf[1].Payload.optionsarray Sì
$.oneOf[0].allOf[1].Payload.options[]object No
$.oneOf[0].allOf[1].Payload.options[].valuestring ["AllowAnyone","CurrentOwnerResellOnly"] Sì
$.oneOf[0].allOf[1].Payload.options[].labelstring Sì
$.oneOf[0].allOf[1].Payload.restrictedByRegulationboolean Sì
$.oneOf[0].allOf[1].Payload.blockingRegulation Sì
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0].namestring Sì
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0].effectiveDateStartstring Sì
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0].idinteger Sì
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[1]null Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/partner/get_location_claim_options

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
q string No "" Search query.
pageSize int No 15 Maximum options to return.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.appointmenttrader.com/v1/partner/get_location_claim_options' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'q={{q}}' \
  --data-urlencode 'pageSize={{pageSize}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_get_location_claim_options_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.querystring Sì
$.oneOf[0].allOf[1].Payload.optionsarray Sì
$.oneOf[0].allOf[1].Payload.options[]object No
$.oneOf[0].allOf[1].Payload.options[].valuestring Sì
$.oneOf[0].allOf[1].Payload.options[].labelstring Sì
$.oneOf[0].allOf[1].Payload.options[].subtitlestring Sì
$.oneOf[0].allOf[1].Payload.options[].keywordsstring Sì
$.oneOf[0].allOf[1].Payload.options[].aliasstring Sì
$.oneOf[0].allOf[1].Payload.options[].citystring Sì
$.oneOf[0].allOf[1].Payload.options[].countryShortstring Sì
$.oneOf[0].allOf[1].Payload.options[].categoryNamestring Sì
$.oneOf[0].allOf[1].Payload.options[].managementURLstring Sì
$.oneOf[0].allOf[1].Payload.options[].profileURLstring Sì
$.oneOf[0].allOf[1].Payload.options[].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.options[].canManageboolean Sì
$.oneOf[0].allOf[1].Payload.options[].canRequestClaimboolean Sì
$.oneOf[0].allOf[1].Payload.options[].pendingRequest Sì
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0].chatURLstring Sì
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0].requestIDinteger Sì
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0].chatIDinteger Sì
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.schemaobject Sì
$.oneOf[0].allOf[1].Payload.schema.readyboolean Sì
$.oneOf[0].allOf[1].Payload.schema.missingTablesarray Sì
$.oneOf[0].allOf[1].Payload.schema.missingTables[]string No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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": []
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/partner/get_location_dashboard

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to inspect.
overviewRange string No "30d" Timeframe key: 1d, 7d, 30d, or custom.
overviewFrom string No "" Custom range start date when overviewRange is custom.
overviewTo string No "" Custom range end date when overviewRange is custom.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_get_location_dashboard_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.Dashboardobject Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summaryobject Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summary.ViewsDatabaseNumber NoNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views.oneOf[0]number No
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.Dashboard.summary.BidsDatabaseNumber NoNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids.oneOf[0]number No
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.Dashboard.summary.ActiveListingsDatabaseNumber NoNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.ActiveListings.oneOf[0]number No
$.oneOf[0].allOf[1].Payload.Dashboard.summary.ActiveListings.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSalesDatabaseNumber NoNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales.oneOf[0]number No
$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolumeDatabaseNumber NoNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume.oneOf[0]number No
$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views30DayDatabaseNumber SìNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views30Day.oneOf[0]number Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views30Day.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids30DayDatabaseNumber SìNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids30Day.oneOf[0]number Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids30Day.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales90DayDatabaseNumber SìNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales90Day.oneOf[0]number Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales90Day.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume90DayDatabaseNumber SìNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume90Day.oneOf[0]number Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume90Day.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Dashboard.trendarray Sì
$.oneOf[0].allOf[1].Payload.Dashboard.trend[]object No
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Date Sì
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Date.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Date.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].ViewsDatabaseNumber SìNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Views.oneOf[0]number Sì
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Views.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].SalesDatabaseNumber SìNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Sales.oneOf[0]number Sì
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Sales.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].GrossVolumeDatabaseNumber SìNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].GrossVolume.oneOf[0]number Sì
$.oneOf[0].allOf[1].Payload.Dashboard.trend[].GrossVolume.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypesarray Sì
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[]object No
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].IDDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ID.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].Namestring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ListingCountDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ListingCount.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ListingCount.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].SalesCountDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].SalesCount.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].SalesCount.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].GrossVolumeDatabaseNumber SìNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].GrossVolume.oneOf[0]number Sì
$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].GrossVolume.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormattedobject Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.viewsstring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.bidsstring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.activeListingsstring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.completedSalesstring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.grossVolumestring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.conversionstring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.views30Daystring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.bids30Daystring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.completedSales90Daystring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.grossVolume90Daystring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.timeframeobject Sì
$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.keystring ["1d","7d","30d","custom"] Sì
$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.fromDatestring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.toDatestring Sì
$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.daysinteger Sì
$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.labelstring Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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"
            }
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int No 0 Target location ID.
locationAlias string No "" Optional target location alias when locationID is not supplied.
dateRange string No "30d" One of 30d, 60d, 90d, custom.
startDate string No "" Custom range start date when dateRange=custom, YYYY-MM-DD.
endDate string No "" Custom range end date when dateRange=custom, YYYY-MM-DD.
sourceLocationIDs string No "" Optional comma-separated similar restaurant location IDs. If empty, saved similar restaurants are used.
sourceLocationAliases string No "" Optional comma-separated similar restaurant aliases.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_get_location_inventory_forecast_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.sourceLocationIDsarray Sì
$.oneOf[0].allOf[1].Payload.sourceLocationIDs[]integer No
$.oneOf[0].allOf[1].Payload.forecastobject Sì
$.oneOf[0].allOf[1].Payload.forecast.location Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].locationAliasstring Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].locationNamestring Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].marketLinestring Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].categoryNamestring Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].categoryID Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].categoryID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].categoryID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocationsarray Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations[]object No
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations[].locationAliasstring Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations[].locationNamestring Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations[].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceModestring ["likeness","direct"] Sì
$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[1]array Sì
$.oneOf[0].allOf[1].Payload.forecast.timeframeobject Sì
$.oneOf[0].allOf[1].Payload.forecast.timeframe.keystring ["30d","60d","90d","custom"] Sì
$.oneOf[0].allOf[1].Payload.forecast.timeframe.daysinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.timeframe.fromstring Sì
$.oneOf[0].allOf[1].Payload.forecast.timeframe.tostring Sì
$.oneOf[0].allOf[1].Payload.forecast.timeframe.fromDatestring Sì
$.oneOf[0].allOf[1].Payload.forecast.timeframe.toDatestring Sì
$.oneOf[0].allOf[1].Payload.forecast.timeframe.labelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.summary Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].rowCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].opportunityRowCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].sourceLocationCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessmentobject Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.labelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.averagePriceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.confidenceLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.recommendedListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.activeListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.neededListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.averagePriceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.recentViewCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.showByDefaultboolean Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.statusstring ["room_for_supply","good_supply","oversupply","no_estimation"] Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.tonestring ["neutral","positive","warning"] Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.confidencestring ["high","medium","developing"] Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.reasonCodesarray Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.reasonCodes[]string ["history","likeness","events","current_demand","popularity","supply","views"] No
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.reasonLabelsarray Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.reasonLabels[]string No
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceConfidenceLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceBasisLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.isEstimatedPriceboolean Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceConfidencestring ["high","medium","low","none"] Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceBasisstring ["direct_market","active_supply","related_market","related_country","comparable_sales","none"] Sì
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.comparableSaleCountinteger No
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.isExactInventoryComparableboolean No
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.relatedPriceLocationIDinteger No
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.relatedPriceLocationNamestring No
$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[1]array Sì
$.oneOf[0].allOf[1].Payload.forecast.rowsarray Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[]object No
$.oneOf[0].allOf[1].Payload.forecast.rows[].inventoryTypeNamestring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].datestring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].dateLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].dateWithDayLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].timeframeLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].averagePriceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].suggestedPriceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].confidenceLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].directAveragePriceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].inventoryTypeIDinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].demandSignalCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].directDemandSignalCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].historyYearCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].activeListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].sellerCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].recommendedListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].neededListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].averagePriceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].suggestedPriceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].popularityTierinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].directAveragePriceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].isLikenessBasedboolean Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].requiresInventoryMappingboolean Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].startHour Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].startHour.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].startHour.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].confidencestring ["high","medium","developing"] Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].evidenceReasonCodesarray Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].evidenceReasonCodes[]string ["history","likeness","supply","popularity"] No
$.oneOf[0].allOf[1].Payload.forecast.rows[].evidenceLabelsarray Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].evidenceLabels[]string No
$.oneOf[0].allOf[1].Payload.forecast.rows[].sourceModestring ["direct","likeness","direct+likeness"] Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].sourceLocationIDsarray Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].sourceLocationIDs[]integer No
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessmentobject Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.labelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.averagePriceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.confidenceLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.recommendedListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.activeListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.neededListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.averagePriceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.recentViewCountinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.showByDefaultboolean Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.statusstring ["room_for_supply","good_supply","oversupply","no_estimation"] Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.tonestring ["neutral","positive","warning"] Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.confidencestring ["high","medium","developing"] Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.reasonCodesarray Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.reasonCodes[]string ["history","likeness","events","current_demand","popularity","supply","views"] No
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.reasonLabelsarray Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.reasonLabels[]string No
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceConfidenceLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceBasisLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.isEstimatedPriceboolean Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceConfidencestring ["high","medium","low","none"] Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceBasisstring ["direct_market","active_supply","related_market","related_country","comparable_sales","none"] Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.comparableSaleCountinteger No
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.isExactInventoryComparableboolean No
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.relatedPriceLocationIDinteger No
$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.relatedPriceLocationNamestring No
$.oneOf[0].allOf[1].Payload.forecast.rows[].competitionobject Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.countinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listingsarray Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[]object No
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingIDstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingURLstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].locationAliasstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].inventoryTypeNamestring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingDatestring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingTimeLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingDateTimeLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].askingPriceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].inventoryTypeIDinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].askingPriceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingViewsOneDayinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingViewsAllTimeinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingPopularityScoreBracketinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].isRequestingUserListingboolean Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingStartHour Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingStartHour.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingStartHour.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].priceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].priceConfidenceLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].priceBasisLabelstring Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].priceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].isEstimatedPriceboolean Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].priceConfidencestring ["high","medium","low","none"] Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].priceBasisstring ["direct_market","active_supply","related_market","related_country","comparable_sales","none"] Sì
$.oneOf[0].allOf[1].Payload.forecast.rows[].comparableSaleCountinteger No
$.oneOf[0].allOf[1].Payload.forecast.rows[].isExactInventoryComparableboolean No
$.oneOf[0].allOf[1].Payload.forecast.sourceLocationIDsarray Sì
$.oneOf[0].allOf[1].Payload.forecast.sourceLocationIDs[]integer No
$.oneOf[0].allOf[1].Payload.location Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].locationAliasstring Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].locationNamestring Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].marketLinestring Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].categoryNamestring Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].categoryID Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].categoryID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].categoryID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocationsarray Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations[]object No
$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations[].locationAliasstring Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations[].locationNamestring Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations[].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceModestring ["likeness","direct"] Sì
$.oneOf[0].allOf[1].Payload.location.anyOf[1]array Sì
$.oneOf[0].allOf[1].Payload.timeframeobject Sì
$.oneOf[0].allOf[1].Payload.timeframe.keystring ["30d","60d","90d","custom"] Sì
$.oneOf[0].allOf[1].Payload.timeframe.daysinteger Sì
$.oneOf[0].allOf[1].Payload.timeframe.fromstring Sì
$.oneOf[0].allOf[1].Payload.timeframe.tostring Sì
$.oneOf[0].allOf[1].Payload.timeframe.fromDatestring Sì
$.oneOf[0].allOf[1].Payload.timeframe.toDatestring Sì
$.oneOf[0].allOf[1].Payload.timeframe.labelstring Sì
$.oneOf[0].allOf[1].Payload.summary Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].rowCountinteger Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].opportunityRowCountinteger Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].sourceLocationCountinteger Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessmentobject Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.labelstring Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.averagePriceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.confidenceLabelstring Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.recommendedListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.activeListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.neededListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.averagePriceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.recentViewCountinteger Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.showByDefaultboolean Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.statusstring ["room_for_supply","good_supply","oversupply","no_estimation"] Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.tonestring ["neutral","positive","warning"] Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.confidencestring ["high","medium","developing"] Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.reasonCodesarray Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.reasonCodes[]string ["history","likeness","events","current_demand","popularity","supply","views"] No
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.reasonLabelsarray Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.reasonLabels[]string No
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceConfidenceLabelstring Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceBasisLabelstring Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.isEstimatedPriceboolean Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceConfidencestring ["high","medium","low","none"] Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceBasisstring ["direct_market","active_supply","related_market","related_country","comparable_sales","none"] Sì
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.comparableSaleCountinteger No
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.isExactInventoryComparableboolean No
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.relatedPriceLocationIDinteger No
$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.relatedPriceLocationNamestring No
$.oneOf[0].allOf[1].Payload.summary.anyOf[1]array Sì
$.oneOf[0].allOf[1].Payload.rowsarray Sì
$.oneOf[0].allOf[1].Payload.rows[]object No
$.oneOf[0].allOf[1].Payload.rows[].inventoryTypeNamestring Sì
$.oneOf[0].allOf[1].Payload.rows[].datestring Sì
$.oneOf[0].allOf[1].Payload.rows[].dateLabelstring Sì
$.oneOf[0].allOf[1].Payload.rows[].dateWithDayLabelstring Sì
$.oneOf[0].allOf[1].Payload.rows[].timeframeLabelstring Sì
$.oneOf[0].allOf[1].Payload.rows[].averagePriceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.rows[].suggestedPriceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.rows[].confidenceLabelstring Sì
$.oneOf[0].allOf[1].Payload.rows[].directAveragePriceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.rows[].inventoryTypeIDinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].demandSignalCountinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].directDemandSignalCountinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].historyYearCountinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].activeListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].sellerCountinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].recommendedListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].neededListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].averagePriceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].suggestedPriceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].popularityTierinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].directAveragePriceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].isLikenessBasedboolean Sì
$.oneOf[0].allOf[1].Payload.rows[].requiresInventoryMappingboolean Sì
$.oneOf[0].allOf[1].Payload.rows[].startHour Sì
$.oneOf[0].allOf[1].Payload.rows[].startHour.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.rows[].startHour.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.rows[].confidencestring ["high","medium","developing"] Sì
$.oneOf[0].allOf[1].Payload.rows[].evidenceReasonCodesarray Sì
$.oneOf[0].allOf[1].Payload.rows[].evidenceReasonCodes[]string ["history","likeness","supply","popularity"] No
$.oneOf[0].allOf[1].Payload.rows[].evidenceLabelsarray Sì
$.oneOf[0].allOf[1].Payload.rows[].evidenceLabels[]string No
$.oneOf[0].allOf[1].Payload.rows[].sourceModestring ["direct","likeness","direct+likeness"] Sì
$.oneOf[0].allOf[1].Payload.rows[].sourceLocationIDsarray Sì
$.oneOf[0].allOf[1].Payload.rows[].sourceLocationIDs[]integer No
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessmentobject Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.labelstring Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.averagePriceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.confidenceLabelstring Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.recommendedListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.activeListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.neededListingCountinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.averagePriceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.recentViewCountinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.showByDefaultboolean Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.statusstring ["room_for_supply","good_supply","oversupply","no_estimation"] Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.tonestring ["neutral","positive","warning"] Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.confidencestring ["high","medium","developing"] Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.reasonCodesarray Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.reasonCodes[]string ["history","likeness","events","current_demand","popularity","supply","views"] No
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.reasonLabelsarray Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.reasonLabels[]string No
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceConfidenceLabelstring Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceBasisLabelstring Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.isEstimatedPriceboolean Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceConfidencestring ["high","medium","low","none"] Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceBasisstring ["direct_market","active_supply","related_market","related_country","comparable_sales","none"] Sì
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.comparableSaleCountinteger No
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.isExactInventoryComparableboolean No
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.relatedPriceLocationIDinteger No
$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.relatedPriceLocationNamestring No
$.oneOf[0].allOf[1].Payload.rows[].competitionobject Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.countinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listingsarray Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[]object No
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingIDstring Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingURLstring Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].locationAliasstring Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].inventoryTypeNamestring Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingDatestring Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingTimeLabelstring Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingDateTimeLabelstring Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].askingPriceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].inventoryTypeIDinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].askingPriceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingViewsOneDayinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingViewsAllTimeinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingPopularityScoreBracketinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].isRequestingUserListingboolean Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingStartHour Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingStartHour.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingStartHour.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.rows[].priceFormattedstring Sì
$.oneOf[0].allOf[1].Payload.rows[].priceConfidenceLabelstring Sì
$.oneOf[0].allOf[1].Payload.rows[].priceBasisLabelstring Sì
$.oneOf[0].allOf[1].Payload.rows[].priceCentsinteger Sì
$.oneOf[0].allOf[1].Payload.rows[].isEstimatedPriceboolean Sì
$.oneOf[0].allOf[1].Payload.rows[].priceConfidencestring ["high","medium","low","none"] Sì
$.oneOf[0].allOf[1].Payload.rows[].priceBasisstring ["direct_market","active_supply","related_market","related_country","comparable_sales","none"] Sì
$.oneOf[0].allOf[1].Payload.rows[].comparableSaleCountinteger No
$.oneOf[0].allOf[1].Payload.rows[].isExactInventoryComparableboolean No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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": []
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/partner/get_location_likeness_group

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to inspect.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.appointmenttrader.com/v1/partner/get_location_likeness_group' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_get_location_likeness_group_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.LocationIDinteger Sì
$.oneOf[0].allOf[1].Payload.Schemaobject Sì
$.oneOf[0].allOf[1].Payload.Schema.readyboolean Sì
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray Sì
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]string No
$.oneOf[0].allOf[1].Payload.SelectedOptionsarray Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[]object No
$.oneOf[0].allOf[1].Payload.SelectedOptions[].valuestring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].labelstring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].subtitlestring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].keywordsstring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].aliasstring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].namestring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].cityLinestring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].categoryNamestring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].sourcestring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].relationshipCountinteger Sì
$.oneOf[0].allOf[1].Payload.SelectedLocationIDsarray Sì
$.oneOf[0].allOf[1].Payload.SelectedLocationIDs[]integer No
$.oneOf[0].allOf[1].Payload.SelectedAliasesarray Sì
$.oneOf[0].allOf[1].Payload.SelectedAliases[]string No
$.oneOf[0].allOf[1].Payload.SuggestedOptionsarray Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[]object No
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].valuestring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].labelstring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].subtitlestring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].keywordsstring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].aliasstring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].namestring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].cityLinestring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].categoryNamestring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].sourcestring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].relationshipCountinteger Sì
$.oneOf[0].allOf[1].Payload.CanEditboolean Sì
$.oneOf[0].allOf[1].Payload.CanBulkAvailabilityboolean Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/partner/get_location_likeness_options

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Target location ID.
q string No "" Search query.
pageSize int No 15 Maximum options to return.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_get_location_likeness_options_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.optionsarray Sì
$.oneOf[0].allOf[1].Payload.options[]object No
$.oneOf[0].allOf[1].Payload.options[].valuestring Sì
$.oneOf[0].allOf[1].Payload.options[].labelstring Sì
$.oneOf[0].allOf[1].Payload.options[].subtitlestring Sì
$.oneOf[0].allOf[1].Payload.options[].keywordsstring Sì
$.oneOf[0].allOf[1].Payload.options[].aliasstring Sì
$.oneOf[0].allOf[1].Payload.options[].namestring Sì
$.oneOf[0].allOf[1].Payload.options[].cityLinestring Sì
$.oneOf[0].allOf[1].Payload.options[].categoryNamestring Sì
$.oneOf[0].allOf[1].Payload.options[].sourcestring Sì
$.oneOf[0].allOf[1].Payload.options[].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.options[].relationshipCountinteger Sì
$.oneOf[0].allOf[1].Payload.pageSizeinteger Sì
$.oneOf[0].allOf[1].Payload.querystring Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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"
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/partner/get_location_livestream

#
Get the featured livestream post for a managed venue.

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to inspect.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.appointmenttrader.com/v1/partner/get_location_livestream' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_get_location_livestream_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.Featured Sì
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postTitlestring Sì
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postURLstring Sì
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].goLiveURLstring Sì
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].liveStreamStartDatestring Sì
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].boardNamestring Sì
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].featuredLivestreamLinkIDinteger Sì
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postIDinteger Sì
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postAuthorUserIDinteger Sì
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].isLiveboolean Sì
$.oneOf[0].allOf[1].Payload.Featured.anyOf[1]array Sì
$.oneOf[0].allOf[1].Payload.Schemaobject Sì
$.oneOf[0].allOf[1].Payload.Schema.readyboolean Sì
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray Sì
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]string No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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": []
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.appointmenttrader.com/v1/partner/get_locations' \
  --data-urlencode 'key={{API_KEY}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_get_locations_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.schemaobject Sì
$.oneOf[0].allOf[1].Payload.schema.readyboolean Sì
$.oneOf[0].allOf[1].Payload.schema.missingTablesarray Sì
$.oneOf[0].allOf[1].Payload.schema.missingTables[]string No
$.oneOf[0].allOf[1].Payload.locationsarray Sì
$.oneOf[0].allOf[1].Payload.locations[]object No
$.oneOf[0].allOf[1].Payload.locations[].namestring Sì
$.oneOf[0].allOf[1].Payload.locations[].aliasstring Sì
$.oneOf[0].allOf[1].Payload.locations[].cityLinestring Sì
$.oneOf[0].allOf[1].Payload.locations[].partnerAccountNamestring Sì
$.oneOf[0].allOf[1].Payload.locations[].rolestring Sì
$.oneOf[0].allOf[1].Payload.locations[].sourcestring Sì
$.oneOf[0].allOf[1].Payload.locations[].managementURLstring Sì
$.oneOf[0].allOf[1].Payload.locations[].profileURLstring Sì
$.oneOf[0].allOf[1].Payload.locations[].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.locations[].partnerAccountID Sì
$.oneOf[0].allOf[1].Payload.locations[].partnerAccountID.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.locations[].partnerAccountID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.pendingRequestsarray Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[]object No
$.oneOf[0].allOf[1].Payload.pendingRequests[].namestring Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].aliasstring Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].cityLinestring Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].statusstring Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].createdDatestring Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].chatURLstring Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].managementURLstring Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].profileURLstring Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].requestIDinteger Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].chatIDinteger Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationStatusstring Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationChatIDinteger Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationChatURLstring Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationUnreadCount Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationUnreadCount.anyOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationUnreadCount.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].sidebarStatus Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].sidebarStatus.anyOf[0]string ["answer-required","pending"] Sì
$.oneOf[0].allOf[1].Payload.pendingRequests[].sidebarStatus.anyOf[1]null Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/get_locations",
    "RequestUserAlias": "example-user",
    "Payload": {
        "schema": {
            "ready": false,
            "missingTables": []
        },
        "locations": [],
        "pendingRequests": []
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/partner/get_opening_hours

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to inspect.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.appointmenttrader.com/v1/partner/get_opening_hours' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_get_opening_hours_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.OpeningHoursobject Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.schemaobject Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.schema.readyboolean Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.schema.missingTablesarray Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.schema.missingTables[]string No
$.oneOf[0].allOf[1].Payload.OpeningHours.sourcestring ["legacy","split"] Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.maxWindowsPerDay = 4 Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.daysarray Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[]object No
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].keystring Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].labelstring Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].humanReadablestring Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].weekdayinteger SìMonday=0 through Sunday=6.
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].openTimeinteger Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].closeTimeinteger Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].closedboolean Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windowsarray Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[]object NoTimes are integer HHMM; close <= open means the following day.
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].openTimeInputstring Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].closeTimeInputstring Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].labelstring Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].idinteger Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].openTimeinteger Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].closeTimeinteger Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].overnightboolean Sì
$.oneOf[0].allOf[1].Payload.OpeningHours.CanEdit = true Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/partner/get_team

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to inspect.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.appointmenttrader.com/v1/partner/get_team' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_get_team_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.Teamobject Sì
$.oneOf[0].allOf[1].Payload.Team.partnerAccountIDinteger No
$.oneOf[0].allOf[1].Payload.Team.membersarray Sì
$.oneOf[0].allOf[1].Payload.Team.members[]object No
$.oneOf[0].allOf[1].Payload.Team.members[].IDDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.members[].ID.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Team.members[].ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Team.members[].ATUser_IDDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.members[].ATUser_ID.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Team.members[].ATUser_ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Team.members[].Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] Sì
$.oneOf[0].allOf[1].Payload.Team.members[].Status = "Active" Sì
$.oneOf[0].allOf[1].Payload.Team.members[].CreatedDatestring Sì
$.oneOf[0].allOf[1].Payload.Team.members[].AcceptedDate Sì
$.oneOf[0].allOf[1].Payload.Team.members[].AcceptedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Team.members[].AcceptedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Team.members[].Aliasstring Sì
$.oneOf[0].allOf[1].Payload.Team.members[].Email Sì
$.oneOf[0].allOf[1].Payload.Team.members[].Email.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Team.members[].Email.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Team.members[].Avatarstring Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].actorUserIDinteger Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].targetUserIDinteger Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].isBlockedboolean Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].blockedDate Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].blockedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].blockedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].isMutedboolean Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].mutedDate Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].mutedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].mutedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].reasonstring Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].personalNotestring Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[1].personalNote = "" Sì
$.oneOf[0].allOf[1].Payload.Team.invitesarray Sì
$.oneOf[0].allOf[1].Payload.Team.invites[]object No
$.oneOf[0].allOf[1].Payload.Team.invites[].IDDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.invites[].ID.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].InviteTokenstring Sì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"] Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].InviteEmail Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].InviteEmail.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].InviteEmail.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].Statusstring ["Pending","Accepted","Revoked","Expired"] Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].CreatedDatestring Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID.anyOf[0]DatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedDate Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].ExpiresDate Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].ExpiresDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].ExpiresDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].CreatedBy-ATUser_IDDatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.Team.invites[].CreatedBy-ATUser_ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Team.auditarray Sì
$.oneOf[0].allOf[1].Payload.Team.audit[]object No
$.oneOf[0].allOf[1].Payload.Team.audit[].IDDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.Team.audit[].ID.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].CreatedDatestring Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].Actionstring Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID.anyOf[0]DatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID.anyOf[0]DatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0]string (application/json) Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0]PartnerAuditContext (JSON decodificato) Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].previousPolicystring ["None","AllowAnyone","CurrentOwnerResellOnly"] No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].policystring ["AllowAnyone","CurrentOwnerResellOnly"] No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].requestIDDatabaseInteger NoInteger 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 No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].requestID.oneOf[1]string No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].locationIDsarray No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].locationIDs[]integer No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].countinteger No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].dayCountinteger No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].windowCountinteger No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].reasonstring No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].alreadyDeletedboolean No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummaryobject No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary.penaltyCountinteger Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary.existingPenaltyCountinteger Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary.pointsAmountinteger Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary.currencyAmountinteger Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inventoryTypeIDinteger No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].postIDinteger No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].createdPostboolean No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].rowCountinteger No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].createdCountinteger No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].errorCountinteger No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].appointmentIDsarray No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].appointmentIDs[]integer No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID.anyOf[0]DatabaseInteger NoInteger 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 No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID.anyOf[0].oneOf[1]string No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID.anyOf[1]boolean No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].emailstring No
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[1]array Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ActorAlias Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ActorAlias.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].ActorAlias.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].TargetAlias Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].TargetAlias.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.Team.audit[].TargetAlias.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.Schemaobject Sì
$.oneOf[0].allOf[1].Payload.Schema.readyboolean Sì
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray Sì
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]string No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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": []
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
POST

/v1/partner/set_bulk_availability

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to manage.
csvRows string Sì — CSV rows using partner/get_bulk_availability_template.
createMissingInventoryTypes bool No false Create unknown inventory types before writing rows.
isWritingRequest bool No false Dry-run guard for writes.
Esempio di richiesta (cURL) 
curl --request POST \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_set_bulk_availability_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload Sì
$.oneOf[0].allOf[1].Payload.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rowsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].rowNumberinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].statusstring ["valid","error","created"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].errorsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].errors[]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalizedobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.inventoryTypeNamestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.dateTimestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.currencyCodestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.firstNamestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.lastNamestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.emailAddressstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.phoneNumberstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.inventoryTypeIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.quantityinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.priceAmountInSmallestUnitinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.discussionPostIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.createInventoryTypeboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0]array Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][]PartnerImportJSONValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4][]PartnerImportJSONValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5].*PartnerImportJSONValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*PartnerImportJSONValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4][]PartnerImportJSONValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5].*PartnerImportJSONValue No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].appointmentIDsarray No
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].appointmentIDs[]integer No
$.oneOf[0].allOf[1].Payload.anyOf[0].Summaryobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.rowCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.validCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.errorCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.missingInventoryTypesarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.missingInventoryTypes[]string No
$.oneOf[0].allOf[1].Payload.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[0]DatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[1]boolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rowsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].rowNumberinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].statusstring ["valid","error","created"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].errorsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].errors[]string No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalizedobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.inventoryTypeNamestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.dateTimestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.currencyCodestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.firstNamestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.lastNamestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.emailAddressstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.phoneNumberstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.inventoryTypeIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.quantityinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.priceAmountInSmallestUnitinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.discussionPostIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.createInventoryTypeboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0]array Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][]PartnerImportJSONValue No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4][]PartnerImportJSONValue No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5].*PartnerImportJSONValue No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*PartnerImportJSONValue No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[0]null No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[1]string No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[2]number No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[3]boolean No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4]array No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4][]PartnerImportJSONValue No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5].*PartnerImportJSONValue No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].appointmentIDsarray No
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].appointmentIDs[]integer No
$.oneOf[0].allOf[1].Payload.anyOf[1].Summaryobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.rowCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.createdCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.errorCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.appointmentIDsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.appointmentIDs[]integer No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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": []
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to delete.
reason string No "" Community-standards reason shown in audit and penalty ledger descriptions.
confirmation string No "" Type DELETE when isWritingRequest is true.
isWritingRequest bool No false False returns a dry-run penalty preview; true soft-deletes and applies penalties.
Esempio di richiesta (cURL) 
curl --request POST \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_set_delete_location_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload Sì
$.oneOf[0].allOf[1].Payload.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].AlreadyDeletedboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].LocationIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].LocationNamestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreviewobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Succeeded = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.DryRunboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.LocationIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.ProposalCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summaryobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.penaltyCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.existingPenaltyCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.pointsAmountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.currencyAmountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penaltiesarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].rolestring ["submitter","verifier"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].userIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].rewardLedgerIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].confirmationIDinteger Sì
$.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"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].penaltyLedgerIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].pointsAmountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].currencyAmountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].accountIDinteger No
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].penaltyMultipliernumber No
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].proposalIDinteger No
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].locationIDinteger No
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].locationNamestring No
$.oneOf[0].allOf[1].Payload.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].DryRun = false Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].AlreadyDeletedboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].LocationIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].LocationNamestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResultobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Succeeded = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.DryRunboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.LocationIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.ProposalCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summaryobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.penaltyCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.existingPenaltyCountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.pointsAmountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.currencyAmountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penaltiesarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].rolestring ["submitter","verifier"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].userIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].rewardLedgerIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].confirmationIDinteger Sì
$.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"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].penaltyLedgerIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].pointsAmountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].currencyAmountinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].accountIDinteger No
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].penaltyMultipliernumber No
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].proposalIDinteger No
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].locationIDinteger No
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].locationNamestring No
$.oneOf[0].allOf[1].Payload.anyOf[1].RedirectURLstring Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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": []
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
POST

/v1/partner/set_inventory_type

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to manage.
inventoryTypeID int No 0 Existing inventory type ID, or 0 to create one.
name string No "" Inventory type name.
description string No "" Short description.
allowListings bool No true Whether sellers can create listings for this type.
groupName string No "" Optional group label.
headcount int No 0 Optional default headcount.
defaultBidAmount int No 0 Default bid amount in cents.
defaultOfferAmount int No 0 Default offer amount in cents.
isWritingRequest bool No false Dry-run guard for writes.
Esempio di richiesta (cURL) 
curl --request POST \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_set_inventory_type_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload Sì
$.oneOf[0].allOf[1].Payload.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].InventoryTypeIDinteger Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_inventory_type",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}
Documentazione dell’endpoint leggibile dalle macchine
POST

/v1/partner/set_inventory_type_post_link

#
Link a community post to a venue inventory type.

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to manage.
inventoryTypeID int Sì — Inventory type ID.
discussionPostID int Sì — Community post ID to link.
isWritingRequest bool No false Dry-run guard for writes.
Esempio di richiesta (cURL) 
curl --request POST \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_set_inventory_type_post_link_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload Sì
$.oneOf[0].allOf[1].Payload.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[1]array Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_inventory_type_post_link",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to manage.
policy string Sì — One of AllowAnyone or CurrentOwnerResellOnly.
isWritingRequest bool No false Dry-run guard for writes.
Esempio di richiesta (cURL) 
curl --request POST \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_set_listing_regulation_policy_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload Sì
$.oneOf[0].allOf[1].Payload.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].policystring ["AllowAnyone","CurrentOwnerResellOnly"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].policystring ["None","AllowAnyone","CurrentOwnerResellOnly"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].defaultPolicy = "CurrentOwnerResellOnly" Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].canEditboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].schemaobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].schema.readyboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].schema.missingColumnsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].schema.missingColumns[]string No
$.oneOf[0].allOf[1].Payload.anyOf[1].optionsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].options[]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].options[].valuestring ["AllowAnyone","CurrentOwnerResellOnly"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].options[].labelstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].restrictedByRegulationboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0].namestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0].effectiveDateStartstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0].idinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Saved = true Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_listing_regulation_policy",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true,
        "policy": "AllowAnyone"
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to claim.
message string No "" Optional claim note for reviewers.
isWritingRequest bool No false Dry-run guard for writes.
Esempio di richiesta (cURL) 
curl --request POST \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_set_location_claim_request_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload Sì
$.oneOf[0].allOf[1].Payload.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].AlreadyManager = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].ManagementURLstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].ChatURLstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].RequestIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].ChatIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Createdboolean Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_location_claim_request",
    "RequestUserAlias": "example-user",
    "Payload": {
        "AlreadyManager": true,
        "ManagementURL": "synthetic-example"
    }
}
Documentazione dell’endpoint leggibile dalle macchine
POST

/v1/partner/set_location_likeness_group

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Target location ID.
locationIDs string No "" Comma-separated similar restaurant location IDs.
isWritingRequest bool No false Dry-run guard for writes.
Esempio di richiesta (cURL) 
curl --request POST \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_set_location_likeness_group_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.LocationIDinteger Sì
$.oneOf[0].allOf[1].Payload.Schemaobject Sì
$.oneOf[0].allOf[1].Payload.Schema.readyboolean Sì
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray Sì
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]string No
$.oneOf[0].allOf[1].Payload.SelectedOptionsarray Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[]object No
$.oneOf[0].allOf[1].Payload.SelectedOptions[].valuestring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].labelstring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].subtitlestring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].keywordsstring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].aliasstring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].namestring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].cityLinestring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].categoryNamestring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].sourcestring Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.SelectedOptions[].relationshipCountinteger Sì
$.oneOf[0].allOf[1].Payload.SelectedLocationIDsarray Sì
$.oneOf[0].allOf[1].Payload.SelectedLocationIDs[]integer No
$.oneOf[0].allOf[1].Payload.SelectedAliasesarray Sì
$.oneOf[0].allOf[1].Payload.SelectedAliases[]string No
$.oneOf[0].allOf[1].Payload.SuggestedOptionsarray Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[]object No
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].valuestring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].labelstring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].subtitlestring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].keywordsstring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].aliasstring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].namestring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].cityLinestring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].categoryNamestring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].sourcestring Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].relationshipCountinteger Sì
$.oneOf[0].allOf[1].Payload.CanEditboolean Sì
$.oneOf[0].allOf[1].Payload.CanBulkAvailabilityboolean Sì
$.oneOf[0].allOf[1].Payload.SavedCountinteger Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to manage.
discussionPostID int No 0 Existing public top-level location post to feature. Use 0 when createPost is true.
title string No "" Optional title for a newly created station post.
body string No "" Optional body for a newly created station post.
createPost bool No false Create a new location discussion post before featuring it.
clear bool No false Remove the featured livestream post from the public location page.
isWritingRequest bool No false Dry-run guard for writes.
Esempio di richiesta (cURL) 
curl --request POST \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_set_location_livestream_post_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload Sì
$.oneOf[0].allOf[1].Payload.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Featuredarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].DiscussionPostIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postTitlestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postURLstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].goLiveURLstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].liveStreamStartDatestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].boardNamestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].featuredLivestreamLinkIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].locationIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postAuthorUserIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].isLiveboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[1]array Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].PostURLstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].GoLiveURLstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[2]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].DryRun = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].WouldCreatePost = true No
$.oneOf[0].allOf[1].Payload.anyOf[2].DiscussionPostIDinteger No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_location_livestream_post",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Featured": []
    }
}
Documentazione dell’endpoint leggibile dalle macchine
POST

/v1/partner/set_opening_hours

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to manage.
hoursJSON string No "" JSON payload with days, closed flags, and open/close windows.
isWritingRequest bool No false Dry-run guard for writes.
Esempio di richiesta (cURL) 
curl --request POST \
  'https://it.appointmenttrader.com/v1/partner/set_opening_hours' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'hoursJSON={{hoursJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Risposta

JSON
See the shared response schema and synthetic example.
Parametri: hoursJSON
CampoTipoObbligatorioDescrizione
hoursJSONstring (application/json) No
hoursJSONPartnerOpeningHoursInput (JSON decodificato) NoOmitted 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 No
hoursJSON.anyOf[0].days Sì
hoursJSON.anyOf[0].days.anyOf[0]array Sì
hoursJSON.anyOf[0].days.anyOf[0][]object No
hoursJSON.anyOf[0].days.anyOf[0][].weekdayinteger No
hoursJSON.anyOf[0].days.anyOf[0][].closedboolean No
hoursJSON.anyOf[0].days.anyOf[0][].windowsarray No
hoursJSON.anyOf[0].days.anyOf[0][].windows[]object NoSupply 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 No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTime.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].open No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].open.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].open.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].OpenTime No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].OpenTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].OpenTime.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTimeInput No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTimeInput.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTimeInput.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTime No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTime.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].close No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].close.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].close.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].CloseTime No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].CloseTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].CloseTime.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTimeInput No
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTimeInput.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTimeInput.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[1]object Sì
hoursJSON.anyOf[0].days.anyOf[1].*object No
hoursJSON.anyOf[0].days.anyOf[1].*.weekdayinteger No
hoursJSON.anyOf[0].days.anyOf[1].*.closedboolean No
hoursJSON.anyOf[0].days.anyOf[1].*.windowsarray No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[]object NoSupply 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 No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTime.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].open No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].open.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].open.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].OpenTime No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].OpenTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].OpenTime.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTimeInput No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTimeInput.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTimeInput.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTime No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTime.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].close No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].close.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].close.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].CloseTime No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].CloseTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].CloseTime.anyOf[1]integer No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTimeInput No
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTimeInput.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTimeInput.anyOf[1]integer No
hoursJSON.anyOf[1] No
hoursJSON.anyOf[1].anyOf[0]array No
hoursJSON.anyOf[1].anyOf[0][]object No
hoursJSON.anyOf[1].anyOf[0][].weekdayinteger No
hoursJSON.anyOf[1].anyOf[0][].closedboolean No
hoursJSON.anyOf[1].anyOf[0][].windowsarray No
hoursJSON.anyOf[1].anyOf[0][].windows[]object NoSupply 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 No
hoursJSON.anyOf[1].anyOf[0][].windows[].openTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].openTime.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[0][].windows[].open No
hoursJSON.anyOf[1].anyOf[0][].windows[].open.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].open.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[0][].windows[].OpenTime No
hoursJSON.anyOf[1].anyOf[0][].windows[].OpenTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].OpenTime.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[0][].windows[].openTimeInput No
hoursJSON.anyOf[1].anyOf[0][].windows[].openTimeInput.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].openTimeInput.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTime No
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTime.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[0][].windows[].close No
hoursJSON.anyOf[1].anyOf[0][].windows[].close.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].close.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[0][].windows[].CloseTime No
hoursJSON.anyOf[1].anyOf[0][].windows[].CloseTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].CloseTime.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTimeInput No
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTimeInput.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTimeInput.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[1]object No
hoursJSON.anyOf[1].anyOf[1].*object No
hoursJSON.anyOf[1].anyOf[1].*.weekdayinteger No
hoursJSON.anyOf[1].anyOf[1].*.closedboolean No
hoursJSON.anyOf[1].anyOf[1].*.windowsarray No
hoursJSON.anyOf[1].anyOf[1].*.windows[]object NoSupply 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 No
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTime.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[1].*.windows[].open No
hoursJSON.anyOf[1].anyOf[1].*.windows[].open.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].open.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[1].*.windows[].OpenTime No
hoursJSON.anyOf[1].anyOf[1].*.windows[].OpenTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].OpenTime.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTimeInput No
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTimeInput.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTimeInput.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTime No
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTime.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[1].*.windows[].close No
hoursJSON.anyOf[1].anyOf[1].*.windows[].close.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].close.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[1].*.windows[].CloseTime No
hoursJSON.anyOf[1].anyOf[1].*.windows[].CloseTime.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].CloseTime.anyOf[1]integer No
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTimeInput No
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTimeInput.anyOf[0]string NoHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTimeInput.anyOf[1]integer No
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_set_opening_hours_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload Sì
$.oneOf[0].allOf[1].Payload.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].daysarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].keystring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].labelstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].humanReadablestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].weekdayinteger SìMonday=0 through Sunday=6.
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].openTimeinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].closeTimeinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].closedboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windowsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[]object NoTimes are integer HHMM; close <= open means the following day.
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].openTimeInputstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].closeTimeInputstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].labelstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].idinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].openTimeinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].closeTimeinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].overnightboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].rowsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[]object No
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].Weekdayinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].OpenTimeinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].CloseTimeinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].SortOrderinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHoursobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schemaobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema.readyboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema.missingTablesarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema.missingTables[]string No
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.sourcestring ["legacy","split"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.maxWindowsPerDay = 4 Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.daysarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[]object No
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].keystring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].labelstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].humanReadablestring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].weekdayinteger SìMonday=0 through Sunday=6.
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].openTimeinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].closeTimeinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].closedboolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windowsarray Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[]object NoTimes are integer HHMM; close <= open means the following day.
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].openTimeInputstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].closeTimeInputstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].labelstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].idinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].openTimeinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].closeTimeinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].overnightboolean Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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": []
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int No 0 Location ID for the invite.
role string No "Analyst" One of Owner, Admin, InventoryManager, HostSupport, Finance, Analyst.
email string No "" Optional invite email annotation.
inviteToken string No "" Existing invite token to accept instead of creating a new invite.
acceptInvite bool No false Accept inviteToken for the signed-in user.
isWritingRequest bool No false Dry-run guard for writes.
Esempio di richiesta (cURL) 
curl --request POST \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_set_team_invite_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload Sì
$.oneOf[0].allOf[1].Payload.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[0]DatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[1]boolean Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteURLstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].DryRun = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].InviteURLstring Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[2]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Inviteobject Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.IDDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ID.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATPartnerAccount_IDDatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATPartnerAccount_ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[0]DatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteTokenstring Sì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"] Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteEmail Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteEmail.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteEmail.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.Status = "Pending" Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.CreatedBy-ATUser_IDDatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.CreatedBy-ATUser_ID.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[0]DatabaseInteger Sì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 Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedDate Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ExpiresDate Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ExpiresDate.anyOf[0]string Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ExpiresDate.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.anyOf[2].DryRun = true No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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"
    }
}
Documentazione dell’endpoint leggibile dalle macchine
POST

/v1/partner/set_team_member_remove

#
Remove a user from a venue team.

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to manage.
userID int Sì — Team member user ID to remove.
isWritingRequest bool No false Dry-run guard for writes.
Esempio di richiesta (cURL) 
curl --request POST \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_set_team_member_remove_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload Sì
$.oneOf[0].allOf[1].Payload.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[1]array Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_team_member_remove",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}
Documentazione dell’endpoint leggibile dalle macchine
POST

/v1/partner/set_team_member_role

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationID int Sì — Location ID to manage.
aliasOrEmail string Sì — Existing user's alias or email.
role string Sì — One of Owner, Admin, InventoryManager, HostSupport, Finance, Analyst.
isWritingRequest bool No false Dry-run guard for writes.
Esempio di richiesta (cURL) 
curl --request POST \
  'https://it.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}}'

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$partner_set_team_member_role_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payload Sì
$.oneOf[0].allOf[1].Payload.anyOf[0]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Sì
$.oneOf[0].allOf[1].Payload.anyOf[1]object Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].UserIDinteger Sì
$.oneOf[0].allOf[1].Payload.anyOf[1].Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] Sì
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_team_member_role",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}
Documentazione dell’endpoint leggibile dalle macchine