AT AppointmentTrader
Aanmelden
Online nu  

/v1/partner/

GET

/v1/partner/get_bulk_availability_template

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

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_get_bulk_availability_template_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.columnsarray Ja
$.oneOf[0].allOf[1].Payload.columns[]string Nee
$.oneOf[0].allOf[1].Payload.examplestring Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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,\"[]\","
    }
}
Machineleesbare endpointdocumentatie
GET

/v1/partner/get_inventory

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Location ID to inspect.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.appointmenttrader.com/v1/partner/get_inventory' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Retourwaarde

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

/v1/partner/get_listing_regulation_policy

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Location ID to inspect.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.appointmenttrader.com/v1/partner/get_listing_regulation_policy' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_get_listing_regulation_policy_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.policystring ["None","AllowAnyone","CurrentOwnerResellOnly"] Ja
$.oneOf[0].allOf[1].Payload.defaultPolicy = "CurrentOwnerResellOnly" Ja
$.oneOf[0].allOf[1].Payload.canEditboolean Ja
$.oneOf[0].allOf[1].Payload.schemaobject Ja
$.oneOf[0].allOf[1].Payload.schema.readyboolean Ja
$.oneOf[0].allOf[1].Payload.schema.missingColumnsarray Ja
$.oneOf[0].allOf[1].Payload.schema.missingColumns[]string Nee
$.oneOf[0].allOf[1].Payload.optionsarray Ja
$.oneOf[0].allOf[1].Payload.options[]object Nee
$.oneOf[0].allOf[1].Payload.options[].valuestring ["AllowAnyone","CurrentOwnerResellOnly"] Ja
$.oneOf[0].allOf[1].Payload.options[].labelstring Ja
$.oneOf[0].allOf[1].Payload.restrictedByRegulationboolean Ja
$.oneOf[0].allOf[1].Payload.blockingRegulation Ja
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0].namestring Ja
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0].effectiveDateStartstring Ja
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[1]null Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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
        }
    }
}
Machineleesbare endpointdocumentatie
GET

/v1/partner/get_location_claim_options

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
q string Nee "" Search query.
pageSize int Nee 15 Maximum options to return.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.appointmenttrader.com/v1/partner/get_location_claim_options' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'q={{q}}' \
  --data-urlencode 'pageSize={{pageSize}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_get_location_claim_options_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.querystring Ja
$.oneOf[0].allOf[1].Payload.optionsarray Ja
$.oneOf[0].allOf[1].Payload.options[]object Nee
$.oneOf[0].allOf[1].Payload.options[].valuestring Ja
$.oneOf[0].allOf[1].Payload.options[].labelstring Ja
$.oneOf[0].allOf[1].Payload.options[].subtitlestring Ja
$.oneOf[0].allOf[1].Payload.options[].keywordsstring Ja
$.oneOf[0].allOf[1].Payload.options[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.options[].citystring Ja
$.oneOf[0].allOf[1].Payload.options[].countryShortstring Ja
$.oneOf[0].allOf[1].Payload.options[].categoryNamestring Ja
$.oneOf[0].allOf[1].Payload.options[].managementURLstring Ja
$.oneOf[0].allOf[1].Payload.options[].profileURLstring Ja
$.oneOf[0].allOf[1].Payload.options[].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.options[].canManageboolean Ja
$.oneOf[0].allOf[1].Payload.options[].canRequestClaimboolean Ja
$.oneOf[0].allOf[1].Payload.options[].pendingRequest Ja
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0].chatURLstring Ja
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0].requestIDinteger Ja
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0].chatIDinteger Ja
$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.schemaobject Ja
$.oneOf[0].allOf[1].Payload.schema.readyboolean Ja
$.oneOf[0].allOf[1].Payload.schema.missingTablesarray Ja
$.oneOf[0].allOf[1].Payload.schema.missingTables[]string Nee
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
        }
    }
}
Machineleesbare endpointdocumentatie
GET

/v1/partner/get_location_dashboard

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Location ID to inspect.
overviewRange string Nee "30d" Timeframe key: 1d, 7d, 30d, or custom.
overviewFrom string Nee "" Custom range start date when overviewRange is custom.
overviewTo string Nee "" Custom range end date when overviewRange is custom.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.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}}'

Retourwaarde

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

Parameters

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

Retourwaarde

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

/v1/partner/get_location_likeness_group

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Location ID to inspect.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.appointmenttrader.com/v1/partner/get_location_likeness_group' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_get_location_likeness_group_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.LocationIDinteger Ja
$.oneOf[0].allOf[1].Payload.Schemaobject Ja
$.oneOf[0].allOf[1].Payload.Schema.readyboolean Ja
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray Ja
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]string Nee
$.oneOf[0].allOf[1].Payload.SelectedOptionsarray Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[]object Nee
$.oneOf[0].allOf[1].Payload.SelectedOptions[].valuestring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].labelstring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].subtitlestring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].keywordsstring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].namestring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].cityLinestring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].categoryNamestring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].sourcestring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].relationshipCountinteger Ja
$.oneOf[0].allOf[1].Payload.SelectedLocationIDsarray Ja
$.oneOf[0].allOf[1].Payload.SelectedLocationIDs[]integer Nee
$.oneOf[0].allOf[1].Payload.SelectedAliasesarray Ja
$.oneOf[0].allOf[1].Payload.SelectedAliases[]string Nee
$.oneOf[0].allOf[1].Payload.SuggestedOptionsarray Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[]object Nee
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].valuestring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].labelstring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].subtitlestring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].keywordsstring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].namestring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].cityLinestring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].categoryNamestring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].sourcestring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].relationshipCountinteger Ja
$.oneOf[0].allOf[1].Payload.CanEditboolean Ja
$.oneOf[0].allOf[1].Payload.CanBulkAvailabilityboolean Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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
    }
}
Machineleesbare endpointdocumentatie
GET

/v1/partner/get_location_likeness_options

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Target location ID.
q string Nee "" Search query.
pageSize int Nee 15 Maximum options to return.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_get_location_likeness_options_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.optionsarray Ja
$.oneOf[0].allOf[1].Payload.options[]object Nee
$.oneOf[0].allOf[1].Payload.options[].valuestring Ja
$.oneOf[0].allOf[1].Payload.options[].labelstring Ja
$.oneOf[0].allOf[1].Payload.options[].subtitlestring Ja
$.oneOf[0].allOf[1].Payload.options[].keywordsstring Ja
$.oneOf[0].allOf[1].Payload.options[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.options[].namestring Ja
$.oneOf[0].allOf[1].Payload.options[].cityLinestring Ja
$.oneOf[0].allOf[1].Payload.options[].categoryNamestring Ja
$.oneOf[0].allOf[1].Payload.options[].sourcestring Ja
$.oneOf[0].allOf[1].Payload.options[].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.options[].relationshipCountinteger Ja
$.oneOf[0].allOf[1].Payload.pageSizeinteger Ja
$.oneOf[0].allOf[1].Payload.querystring Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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"
    }
}
Machineleesbare endpointdocumentatie
GET

/v1/partner/get_location_livestream

#
Get the featured livestream post for a managed venue.

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Location ID to inspect.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.appointmenttrader.com/v1/partner/get_location_livestream' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_get_location_livestream_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.Featured Ja
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postTitlestring Ja
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postURLstring Ja
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].goLiveURLstring Ja
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].liveStreamStartDatestring Ja
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].boardNamestring Ja
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].featuredLivestreamLinkIDinteger Ja
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postIDinteger Ja
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postAuthorUserIDinteger Ja
$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].isLiveboolean Ja
$.oneOf[0].allOf[1].Payload.Featured.anyOf[1]array Ja
$.oneOf[0].allOf[1].Payload.Schemaobject Ja
$.oneOf[0].allOf[1].Payload.Schema.readyboolean Ja
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray Ja
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]string Nee
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
        }
    }
}
Machineleesbare endpointdocumentatie
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.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.appointmenttrader.com/v1/partner/get_locations' \
  --data-urlencode 'key={{API_KEY}}'

Retourwaarde

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

/v1/partner/get_opening_hours

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Location ID to inspect.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.appointmenttrader.com/v1/partner/get_opening_hours' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_get_opening_hours_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.OpeningHoursobject Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.schemaobject Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.schema.readyboolean Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.schema.missingTablesarray Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.schema.missingTables[]string Nee
$.oneOf[0].allOf[1].Payload.OpeningHours.sourcestring ["legacy","split"] Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.maxWindowsPerDay = 4 Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.daysarray Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[]object Nee
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].keystring Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].labelstring Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].humanReadablestring Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].weekdayinteger JaMonday=0 through Sunday=6.
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].openTimeinteger Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].closeTimeinteger Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].closedboolean Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windowsarray Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[]object NeeTimes are integer HHMM; close <= open means the following day.
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].openTimeInputstring Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].closeTimeInputstring Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].labelstring Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].idinteger Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].openTimeinteger Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].closeTimeinteger Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].overnightboolean Ja
$.oneOf[0].allOf[1].Payload.OpeningHours.CanEdit = true Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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
        }
    }
}
Machineleesbare endpointdocumentatie
GET

/v1/partner/get_team

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Location ID to inspect.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.appointmenttrader.com/v1/partner/get_team' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Retourwaarde

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

/v1/partner/set_bulk_availability

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Location ID to manage.
csvRows string Ja — CSV rows using partner/get_bulk_availability_template.
createMissingInventoryTypes bool Nee false Create unknown inventory types before writing rows.
isWritingRequest bool Nee false Dry-run guard for writes.
Voorbeeldverzoek (cURL) 
curl --request POST \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_set_bulk_availability_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload Ja
$.oneOf[0].allOf[1].Payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rowsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].rowNumberinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].statusstring ["valid","error","created"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].errorsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].errors[]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalizedobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.inventoryTypeNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.dateTimestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.currencyCodestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.firstNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.lastNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.emailAddressstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.phoneNumberstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.inventoryTypeIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.quantityinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.priceAmountInSmallestUnitinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.discussionPostIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.createInventoryTypeboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][]PartnerImportJSONValue Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[0]null Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[1]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[2]number Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[3]boolean Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4]array Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4][]PartnerImportJSONValue Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5].*PartnerImportJSONValue Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*PartnerImportJSONValue Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[0]null Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[1]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[2]number Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[3]boolean Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4]array Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4][]PartnerImportJSONValue Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5].*PartnerImportJSONValue Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].appointmentIDsarray Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].appointmentIDs[]integer Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].Summaryobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.rowCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.validCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.errorCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.missingInventoryTypesarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.missingInventoryTypes[]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[1]boolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rowsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].rowNumberinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].statusstring ["valid","error","created"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].errorsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].errors[]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalizedobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.inventoryTypeNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.dateTimestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.currencyCodestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.firstNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.lastNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.emailAddressstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.phoneNumberstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.inventoryTypeIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.quantityinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.priceAmountInSmallestUnitinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.discussionPostIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.createInventoryTypeboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0]array Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][]PartnerImportJSONValue Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[0]null Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[1]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[2]number Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[3]boolean Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4]array Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4][]PartnerImportJSONValue Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5].*PartnerImportJSONValue Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*PartnerImportJSONValue Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[0]null Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[1]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[2]number Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[3]boolean Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4]array Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4][]PartnerImportJSONValue Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5].*PartnerImportJSONValue Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].appointmentIDsarray Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].appointmentIDs[]integer Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].Summaryobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.rowCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.createdCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.errorCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.appointmentIDsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.appointmentIDs[]integer Nee
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
        }
    }
}
Machineleesbare endpointdocumentatie
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.

Parameters

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

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_set_delete_location_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload Ja
$.oneOf[0].allOf[1].Payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].AlreadyDeletedboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].LocationIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].LocationNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreviewobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Succeeded = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.DryRunboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.LocationIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.ProposalCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summaryobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.penaltyCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.existingPenaltyCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.pointsAmountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.currencyAmountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penaltiesarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].rolestring ["submitter","verifier"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].userIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].rewardLedgerIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].confirmationIDinteger Ja
$.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"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].penaltyLedgerIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].pointsAmountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].currencyAmountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].accountIDinteger Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].penaltyMultipliernumber Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].proposalIDinteger Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].locationIDinteger Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].locationNamestring Nee
$.oneOf[0].allOf[1].Payload.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].DryRun = false Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].AlreadyDeletedboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].LocationIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].LocationNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResultobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Succeeded = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.DryRunboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.LocationIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.ProposalCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summaryobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.penaltyCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.existingPenaltyCountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.pointsAmountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.currencyAmountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penaltiesarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].rolestring ["submitter","verifier"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].userIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].rewardLedgerIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].confirmationIDinteger Ja
$.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"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].penaltyLedgerIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].pointsAmountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].currencyAmountinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].accountIDinteger Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].penaltyMultipliernumber Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].proposalIDinteger Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].locationIDinteger Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].locationNamestring Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].RedirectURLstring Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
        }
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/partner/set_inventory_type

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

Parameters

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

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_set_inventory_type_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload Ja
$.oneOf[0].allOf[1].Payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].InventoryTypeIDinteger Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_inventory_type",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/partner/set_inventory_type_post_link

#
Link a community post to a venue inventory type.

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Location ID to manage.
inventoryTypeID int Ja — Inventory type ID.
discussionPostID int Ja — Community post ID to link.
isWritingRequest bool Nee false Dry-run guard for writes.
Voorbeeldverzoek (cURL) 
curl --request POST \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_set_inventory_type_post_link_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload Ja
$.oneOf[0].allOf[1].Payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[1]array Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_inventory_type_post_link",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}
Machineleesbare endpointdocumentatie
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.

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Location ID to manage.
policy string Ja — One of AllowAnyone or CurrentOwnerResellOnly.
isWritingRequest bool Nee false Dry-run guard for writes.
Voorbeeldverzoek (cURL) 
curl --request POST \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_set_listing_regulation_policy_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload Ja
$.oneOf[0].allOf[1].Payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].policystring ["AllowAnyone","CurrentOwnerResellOnly"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].policystring ["None","AllowAnyone","CurrentOwnerResellOnly"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].defaultPolicy = "CurrentOwnerResellOnly" Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].canEditboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].schemaobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].schema.readyboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].schema.missingColumnsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].schema.missingColumns[]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].optionsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].options[]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].options[].valuestring ["AllowAnyone","CurrentOwnerResellOnly"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].options[].labelstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].restrictedByRegulationboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0].namestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0].effectiveDateStartstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Saved = true Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_listing_regulation_policy",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true,
        "policy": "AllowAnyone"
    }
}
Machineleesbare endpointdocumentatie
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.

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Location ID to claim.
message string Nee "" Optional claim note for reviewers.
isWritingRequest bool Nee false Dry-run guard for writes.
Voorbeeldverzoek (cURL) 
curl --request POST \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_set_location_claim_request_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload Ja
$.oneOf[0].allOf[1].Payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].AlreadyManager = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].ManagementURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].ChatURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].RequestIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].ChatIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Createdboolean Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_location_claim_request",
    "RequestUserAlias": "example-user",
    "Payload": {
        "AlreadyManager": true,
        "ManagementURL": "synthetic-example"
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/partner/set_location_likeness_group

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Target location ID.
locationIDs string Nee "" Comma-separated similar restaurant location IDs.
isWritingRequest bool Nee false Dry-run guard for writes.
Voorbeeldverzoek (cURL) 
curl --request POST \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_set_location_likeness_group_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.LocationIDinteger Ja
$.oneOf[0].allOf[1].Payload.Schemaobject Ja
$.oneOf[0].allOf[1].Payload.Schema.readyboolean Ja
$.oneOf[0].allOf[1].Payload.Schema.missingTablesarray Ja
$.oneOf[0].allOf[1].Payload.Schema.missingTables[]string Nee
$.oneOf[0].allOf[1].Payload.SelectedOptionsarray Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[]object Nee
$.oneOf[0].allOf[1].Payload.SelectedOptions[].valuestring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].labelstring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].subtitlestring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].keywordsstring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].namestring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].cityLinestring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].categoryNamestring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].sourcestring Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.SelectedOptions[].relationshipCountinteger Ja
$.oneOf[0].allOf[1].Payload.SelectedLocationIDsarray Ja
$.oneOf[0].allOf[1].Payload.SelectedLocationIDs[]integer Nee
$.oneOf[0].allOf[1].Payload.SelectedAliasesarray Ja
$.oneOf[0].allOf[1].Payload.SelectedAliases[]string Nee
$.oneOf[0].allOf[1].Payload.SuggestedOptionsarray Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[]object Nee
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].valuestring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].labelstring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].subtitlestring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].keywordsstring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].namestring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].cityLinestring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].categoryNamestring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].sourcestring Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.SuggestedOptions[].relationshipCountinteger Ja
$.oneOf[0].allOf[1].Payload.CanEditboolean Ja
$.oneOf[0].allOf[1].Payload.CanBulkAvailabilityboolean Ja
$.oneOf[0].allOf[1].Payload.SavedCountinteger Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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
    }
}
Machineleesbare endpointdocumentatie
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.

Parameters

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

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_set_location_livestream_post_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload Ja
$.oneOf[0].allOf[1].Payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Featuredarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].DiscussionPostIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postTitlestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].goLiveURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].liveStreamStartDatestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].boardNamestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].featuredLivestreamLinkIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postAuthorUserIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].isLiveboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[1]array Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].PostURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].GoLiveURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[2]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].DryRun = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].WouldCreatePost = true Nee
$.oneOf[0].allOf[1].Payload.anyOf[2].DiscussionPostIDinteger Nee
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_location_livestream_post",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Featured": []
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/partner/set_opening_hours

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

Parameters

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

Retourwaarde

JSON
See the shared response schema and synthetic example.
Parameters: hoursJSON
VeldTypeVerplichtBeschrijving
hoursJSONstring (application/json) Nee
hoursJSONPartnerOpeningHoursInput (gedecodeerde JSON) NeeOmitted 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 Nee
hoursJSON.anyOf[0].days Ja
hoursJSON.anyOf[0].days.anyOf[0]array Ja
hoursJSON.anyOf[0].days.anyOf[0][]object Nee
hoursJSON.anyOf[0].days.anyOf[0][].weekdayinteger Nee
hoursJSON.anyOf[0].days.anyOf[0][].closedboolean Nee
hoursJSON.anyOf[0].days.anyOf[0][].windowsarray Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[]object NeeSupply 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 Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTime.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].open Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].open.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].open.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].OpenTime Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].OpenTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].OpenTime.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTimeInput Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTimeInput.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTimeInput.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTime Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTime.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].close Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].close.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].close.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].CloseTime Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].CloseTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].CloseTime.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTimeInput Nee
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTimeInput.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTimeInput.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[1]object Ja
hoursJSON.anyOf[0].days.anyOf[1].*object Nee
hoursJSON.anyOf[0].days.anyOf[1].*.weekdayinteger Nee
hoursJSON.anyOf[0].days.anyOf[1].*.closedboolean Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windowsarray Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[]object NeeSupply 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 Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTime.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].open Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].open.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].open.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].OpenTime Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].OpenTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].OpenTime.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTimeInput Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTimeInput.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTimeInput.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTime Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTime.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].close Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].close.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].close.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].CloseTime Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].CloseTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].CloseTime.anyOf[1]integer Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTimeInput Nee
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTimeInput.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTimeInput.anyOf[1]integer Nee
hoursJSON.anyOf[1] Nee
hoursJSON.anyOf[1].anyOf[0]array Nee
hoursJSON.anyOf[1].anyOf[0][]object Nee
hoursJSON.anyOf[1].anyOf[0][].weekdayinteger Nee
hoursJSON.anyOf[1].anyOf[0][].closedboolean Nee
hoursJSON.anyOf[1].anyOf[0][].windowsarray Nee
hoursJSON.anyOf[1].anyOf[0][].windows[]object NeeSupply 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 Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].openTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].openTime.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].open Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].open.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].open.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].OpenTime Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].OpenTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].OpenTime.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].openTimeInput Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].openTimeInput.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].openTimeInput.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTime Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTime.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].close Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].close.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].close.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].CloseTime Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].CloseTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].CloseTime.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTimeInput Nee
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTimeInput.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[0][].windows[].closeTimeInput.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[1]object Nee
hoursJSON.anyOf[1].anyOf[1].*object Nee
hoursJSON.anyOf[1].anyOf[1].*.weekdayinteger Nee
hoursJSON.anyOf[1].anyOf[1].*.closedboolean Nee
hoursJSON.anyOf[1].anyOf[1].*.windowsarray Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[]object NeeSupply 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 Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTime.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].open Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].open.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].open.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].OpenTime Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].OpenTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].OpenTime.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTimeInput Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTimeInput.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].openTimeInput.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTime Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTime.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].close Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].close.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].close.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].CloseTime Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].CloseTime.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].CloseTime.anyOf[1]integer Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTimeInput Nee
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTimeInput.anyOf[0]string NeeHH:MM, a numeric hour, or numeric HHMM.
hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTimeInput.anyOf[1]integer Nee
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_set_opening_hours_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload Ja
$.oneOf[0].allOf[1].Payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].daysarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].keystring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].labelstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].humanReadablestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].weekdayinteger JaMonday=0 through Sunday=6.
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].openTimeinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].closeTimeinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].closedboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windowsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[]object NeeTimes are integer HHMM; close <= open means the following day.
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].openTimeInputstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].closeTimeInputstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].labelstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].idinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].openTimeinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].closeTimeinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].overnightboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].rowsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].Weekdayinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].OpenTimeinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].CloseTimeinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].SortOrderinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHoursobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schemaobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema.readyboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema.missingTablesarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema.missingTables[]string Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.sourcestring ["legacy","split"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.maxWindowsPerDay = 4 Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.daysarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[]object Nee
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].keystring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].labelstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].humanReadablestring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].weekdayinteger JaMonday=0 through Sunday=6.
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].openTimeinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].closeTimeinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].closedboolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windowsarray Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[]object NeeTimes are integer HHMM; close <= open means the following day.
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].openTimeInputstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].closeTimeInputstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].labelstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].idinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].openTimeinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].closeTimeinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].overnightboolean Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
    }
}
Machineleesbare endpointdocumentatie
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.

Parameters

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

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_set_team_invite_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload Ja
$.oneOf[0].allOf[1].Payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[1]boolean Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].InviteURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].DryRun = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].InviteURLstring Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[2]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Inviteobject Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.IDDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ID.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ID.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATPartnerAccount_IDDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATPartnerAccount_ID.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATPartnerAccount_ID.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[0]DatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteTokenstring JaSynthetic 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"] Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteEmail Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteEmail.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteEmail.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.Status = "Pending" Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.CreatedBy-ATUser_IDDatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.CreatedBy-ATUser_ID.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[0]DatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedDate Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ExpiresDate Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ExpiresDate.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ExpiresDate.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.anyOf[2].DryRun = true Nee
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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"
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/partner/set_team_member_remove

#
Remove a user from a venue team.

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationID int Ja — Location ID to manage.
userID int Ja — Team member user ID to remove.
isWritingRequest bool Nee false Dry-run guard for writes.
Voorbeeldverzoek (cURL) 
curl --request POST \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_set_team_member_remove_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload Ja
$.oneOf[0].allOf[1].Payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[1]array Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_team_member_remove",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/partner/set_team_member_role

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

Parameters

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

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$partner_set_team_member_role_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload Ja
$.oneOf[0].allOf[1].Payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun = true Ja
$.oneOf[0].allOf[1].Payload.anyOf[1]object Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].UserIDinteger Ja
$.oneOf[0].allOf[1].Payload.anyOf[1].Rolestring ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"] Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_team_member_role",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}
Machineleesbare endpointdocumentatie