Référence de l’API partner

GET

/v1/partner/get_bulk_availability_template

#

Get the CSV columns and example row for bulk venue availability imports.

Exemple de requête (cURL)

curl --get \
  'https://fr.appointmenttrader.com/v1/partner/get_bulk_availability_template' \
  --data-urlencode 'key={{API_KEY}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_get_bulk_availability_template_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.columns`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.columns[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.example`	`string`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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,\"[]\","
    }
}

Documentation du point de terminaison lisible par machine

GET

/v1/partner/get_inventory

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to inspect.

Exemple de requête (cURL)

curl --get \
  'https://fr.appointmenttrader.com/v1/partner/get_inventory' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire	Description
`$`	`partner_get_inventory_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].Name`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault`		`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault.anyOf[0]`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault.anyOf[0].oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault.anyOf[0].oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsDefault.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID`		`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID.anyOf[0]`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID.anyOf[0].oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID.anyOf[0].oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocation_ID.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID`		`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].Admin-ATUser_ID.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].Description`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].AllowListings`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].AllowListings.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].AllowListings.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludeGroupNameInLabelText`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludeGroupNameInLabelText.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludeGroupNameInLabelText.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescription`		`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescription.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescription.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescriptionHeadline`		`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescriptionHeadline.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ExtendedDescriptionHeadline.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].PriceIncludesService`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].PriceIncludesService.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].PriceIncludesService.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount`		`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount.anyOf[0]`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount.anyOf[0].oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount.anyOf[0].oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyAmount.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsFallbackOnly`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsFallbackOnly.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsFallbackOnly.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount`		`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount.anyOf[0]`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount.anyOf[0].oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount.anyOf[0].oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].Headcount.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupNameComp`		`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupNameComp.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupNameComp.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocationCategory_ShareableWithResource`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocationCategory_ShareableWithResource.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ATLocationCategory_ShareableWithResource.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IncludedCreditCurrencyPrice`	`number`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].DefaultBidAmount`	`number`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].DefaultOfferAmount`	`number`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].IsClaimed`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].RawName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupEntryCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].GroupName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].ClaimURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink`		`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATLocationInventoryType_ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATLocationInventoryType_ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATLocationInventoryType_ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATDiscussionPosts_ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATDiscussionPosts_ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].ATDiscussionPosts_ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].PostTitle`		`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].PostTitle.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].PostTitle.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[0].URLSlug`	`= ""`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].postLink.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].DefaultBidAmountCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.InventoryTypes[].DefaultOfferAmountCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.PostLinks`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.PostLinks[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.PostLinks[].ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.PostLinks[].ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.PostLinks[].ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.PostLinks[].ATLocationInventoryType_ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.PostLinks[].ATLocationInventoryType_ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.PostLinks[].ATLocationInventoryType_ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.PostLinks[].ATDiscussionPosts_ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.PostLinks[].ATDiscussionPosts_ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.PostLinks[].ATDiscussionPosts_ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.PostLinks[].PostTitle`		`Oui`
`$.oneOf[0].allOf[1].Payload.PostLinks[].PostTitle.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.PostLinks[].PostTitle.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.PostLinks[].URLSlug`	`= ""`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.ready`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.missingTables`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.missingTables[]`	`string`	`Non`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/get_inventory",
    "RequestUserAlias": "example-user",
    "Payload": {
        "InventoryTypes": [],
        "PostLinks": [],
        "Schema": {
            "ready": false,
            "missingTables": []
        }
    }
}

Documentation du point de terminaison lisible par machine

GET

/v1/partner/get_listing_regulation_policy

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to inspect.

Exemple de requête (cURL)

curl --get \
  'https://fr.appointmenttrader.com/v1/partner/get_listing_regulation_policy' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_get_listing_regulation_policy_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.policy`	`string ["None","AllowAnyone","CurrentOwnerResellOnly"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.defaultPolicy`	`= "CurrentOwnerResellOnly"`	`Oui`
`$.oneOf[0].allOf[1].Payload.canEdit`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.schema`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.schema.ready`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.schema.missingColumns`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.schema.missingColumns[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.options`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.options[].value`	`string ["AllowAnyone","CurrentOwnerResellOnly"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.restrictedByRegulation`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.blockingRegulation`		`Oui`
`$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0].name`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0].effectiveDateStart`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[0].id`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.blockingRegulation.anyOf[1]`	`null`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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
        }
    }
}

Documentation du point de terminaison lisible par machine

GET

/v1/partner/get_location_claim_options

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`q`	`string`	`Non`	`""`	Search query.
`pageSize`	`int`	`Non`	`15`	Maximum options to return.

Exemple de requête (cURL)

curl --get \
  'https://fr.appointmenttrader.com/v1/partner/get_location_claim_options' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'q={{q}}' \
  --data-urlencode 'pageSize={{pageSize}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_get_location_claim_options_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.query`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.options[].value`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].subtitle`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].keywords`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].alias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].city`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].countryShort`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].categoryName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].managementURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].profileURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].canManage`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].canRequestClaim`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].pendingRequest`		`Oui`
`$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0].chatURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0].requestID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[0].chatID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].pendingRequest.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.schema`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.schema.ready`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.schema.missingTables`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.schema.missingTables[]`	`string`	`Non`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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": []
        }
    }
}

Documentation du point de terminaison lisible par machine

GET

/v1/partner/get_location_dashboard

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to inspect.
`overviewRange`	`string`	`Non`	`"30d"`	Timeframe key: 1d, 7d, 30d, or custom.
`overviewFrom`	`string`	`Non`	`""`	Custom range start date when overviewRange is custom.
`overviewTo`	`string`	`Non`	`""`	Custom range end date when overviewRange is custom.

Exemple de requête (cURL)

curl --get \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire	Description
`$`	`partner_get_location_dashboard_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views`	`DatabaseNumber`	`Non`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views.oneOf[0]`	`number`	`Non`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views.oneOf[1]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids`	`DatabaseNumber`	`Non`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids.oneOf[0]`	`number`	`Non`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids.oneOf[1]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.ActiveListings`	`DatabaseNumber`	`Non`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.ActiveListings.oneOf[0]`	`number`	`Non`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.ActiveListings.oneOf[1]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales`	`DatabaseNumber`	`Non`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales.oneOf[0]`	`number`	`Non`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales.oneOf[1]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume`	`DatabaseNumber`	`Non`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume.oneOf[0]`	`number`	`Non`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume.oneOf[1]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views30Day`	`DatabaseNumber`	`Oui`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views30Day.oneOf[0]`	`number`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.Views30Day.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids30Day`	`DatabaseNumber`	`Oui`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids30Day.oneOf[0]`	`number`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.Bids30Day.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales90Day`	`DatabaseNumber`	`Oui`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales90Day.oneOf[0]`	`number`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.CompletedSales90Day.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume90Day`	`DatabaseNumber`	`Oui`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume90Day.oneOf[0]`	`number`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summary.GrossVolume90Day.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.trend`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Date`		`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Date.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Date.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Views`	`DatabaseNumber`	`Oui`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Views.oneOf[0]`	`number`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Views.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Sales`	`DatabaseNumber`	`Oui`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Sales.oneOf[0]`	`number`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[].Sales.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[].GrossVolume`	`DatabaseNumber`	`Oui`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[].GrossVolume.oneOf[0]`	`number`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.trend[].GrossVolume.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].Name`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ListingCount`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ListingCount.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].ListingCount.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].SalesCount`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].SalesCount.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].SalesCount.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].GrossVolume`	`DatabaseNumber`	`Oui`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].GrossVolume.oneOf[0]`	`number`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.topInventoryTypes[].GrossVolume.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.views`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.bids`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.activeListings`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.completedSales`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.grossVolume`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.conversion`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.views30Day`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.bids30Day`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.completedSales90Day`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.summaryFormatted.grossVolume90Day`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.timeframe`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.key`	`string ["1d","7d","30d","custom"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.fromDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.toDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.days`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Dashboard.timeframe.label`	`string`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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"
            }
        }
    }
}

Documentation du point de terminaison lisible par machine

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.

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Non`	`0`	Target location ID.
`locationAlias`	`string`	`Non`	`""`	Optional target location alias when locationID is not supplied.
`dateRange`	`string`	`Non`	`"30d"`	One of 30d, 60d, 90d, custom.
`startDate`	`string`	`Non`	`""`	Custom range start date when dateRange=custom, YYYY-MM-DD.
`endDate`	`string`	`Non`	`""`	Custom range end date when dateRange=custom, YYYY-MM-DD.
`sourceLocationIDs`	`string`	`Non`	`""`	Optional comma-separated similar restaurant location IDs. If empty, saved similar restaurants are used.
`sourceLocationAliases`	`string`	`Non`	`""`	Optional comma-separated similar restaurant aliases.

Exemple de requête (cURL)

curl --get \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_get_location_inventory_forecast_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.sourceLocationIDs`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.sourceLocationIDs[]`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location`		`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].locationAlias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].locationName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].marketLine`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].categoryName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].categoryID`		`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].categoryID.anyOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].categoryID.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations[].locationAlias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations[].locationName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceLocations[].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[0].sourceMode`	`string ["likeness","direct"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.location.anyOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.timeframe`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.timeframe.key`	`string ["30d","60d","90d","custom"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.timeframe.days`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.timeframe.from`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.timeframe.to`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.timeframe.fromDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.timeframe.toDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.timeframe.label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary`		`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].rowCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].opportunityRowCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].sourceLocationCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.averagePriceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.confidenceLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.recommendedListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.activeListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.neededListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.averagePriceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.recentViewCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.showByDefault`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.status`	`string ["room_for_supply","good_supply","oversupply","no_estimation"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.tone`	`string ["neutral","positive","warning"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.confidence`	`string ["high","medium","developing"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.reasonCodes`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.reasonCodes[]`	`string ["history","likeness","events","current_demand","popularity","supply","views"]`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.reasonLabels`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.reasonLabels[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceConfidenceLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceBasisLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.isEstimatedPrice`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceConfidence`	`string ["high","medium","low","none"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.priceBasis`	`string ["direct_market","active_supply","related_market","related_country","comparable_sales","none"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.comparableSaleCount`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.isExactInventoryComparable`	`boolean`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.relatedPriceLocationID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[0].supplyAssessment.relatedPriceLocationName`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.summary.anyOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].inventoryTypeName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].date`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].dateLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].dateWithDayLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].timeframeLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].averagePriceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].suggestedPriceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].confidenceLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].directAveragePriceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].inventoryTypeID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].demandSignalCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].directDemandSignalCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].historyYearCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].activeListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].sellerCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].recommendedListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].neededListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].averagePriceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].suggestedPriceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].popularityTier`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].directAveragePriceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].isLikenessBased`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].requiresInventoryMapping`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].startHour`		`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].startHour.anyOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].startHour.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].confidence`	`string ["high","medium","developing"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].evidenceReasonCodes`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].evidenceReasonCodes[]`	`string ["history","likeness","supply","popularity"]`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].evidenceLabels`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].evidenceLabels[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].sourceMode`	`string ["direct","likeness","direct+likeness"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].sourceLocationIDs`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].sourceLocationIDs[]`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.averagePriceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.confidenceLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.recommendedListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.activeListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.neededListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.averagePriceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.recentViewCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.showByDefault`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.status`	`string ["room_for_supply","good_supply","oversupply","no_estimation"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.tone`	`string ["neutral","positive","warning"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.confidence`	`string ["high","medium","developing"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.reasonCodes`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.reasonCodes[]`	`string ["history","likeness","events","current_demand","popularity","supply","views"]`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.reasonLabels`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.reasonLabels[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceConfidenceLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceBasisLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.isEstimatedPrice`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceConfidence`	`string ["high","medium","low","none"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.priceBasis`	`string ["direct_market","active_supply","related_market","related_country","comparable_sales","none"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.comparableSaleCount`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.isExactInventoryComparable`	`boolean`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.relatedPriceLocationID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].supplyAssessment.relatedPriceLocationName`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.count`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingID`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].locationAlias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].inventoryTypeName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingTimeLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingDateTimeLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].askingPriceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].inventoryTypeID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].askingPriceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingViewsOneDay`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingViewsAllTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingPopularityScoreBracket`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].isRequestingUserListing`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingStartHour`		`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingStartHour.anyOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].competition.listings[].listingStartHour.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].priceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].priceConfidenceLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].priceBasisLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].priceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].isEstimatedPrice`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].priceConfidence`	`string ["high","medium","low","none"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].priceBasis`	`string ["direct_market","active_supply","related_market","related_country","comparable_sales","none"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].comparableSaleCount`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.rows[].isExactInventoryComparable`	`boolean`	`Non`
`$.oneOf[0].allOf[1].Payload.forecast.sourceLocationIDs`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.forecast.sourceLocationIDs[]`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.location`		`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].locationAlias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].locationName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].marketLine`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].categoryName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].categoryID`		`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].categoryID.anyOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].categoryID.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations[].locationAlias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations[].locationName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceLocations[].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[0].sourceMode`	`string ["likeness","direct"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.location.anyOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.timeframe`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.timeframe.key`	`string ["30d","60d","90d","custom"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.timeframe.days`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.timeframe.from`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.timeframe.to`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.timeframe.fromDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.timeframe.toDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.timeframe.label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary`		`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].rowCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].opportunityRowCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].sourceLocationCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.averagePriceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.confidenceLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.recommendedListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.activeListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.neededListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.averagePriceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.recentViewCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.showByDefault`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.status`	`string ["room_for_supply","good_supply","oversupply","no_estimation"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.tone`	`string ["neutral","positive","warning"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.confidence`	`string ["high","medium","developing"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.reasonCodes`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.reasonCodes[]`	`string ["history","likeness","events","current_demand","popularity","supply","views"]`	`Non`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.reasonLabels`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.reasonLabels[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceConfidenceLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceBasisLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.isEstimatedPrice`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceConfidence`	`string ["high","medium","low","none"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.priceBasis`	`string ["direct_market","active_supply","related_market","related_country","comparable_sales","none"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.comparableSaleCount`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.isExactInventoryComparable`	`boolean`	`Non`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.relatedPriceLocationID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[0].supplyAssessment.relatedPriceLocationName`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.summary.anyOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.rows[].inventoryTypeName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].date`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].dateLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].dateWithDayLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].timeframeLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].averagePriceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].suggestedPriceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].confidenceLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].directAveragePriceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].inventoryTypeID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].demandSignalCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].directDemandSignalCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].historyYearCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].activeListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].sellerCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].recommendedListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].neededListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].averagePriceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].suggestedPriceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].popularityTier`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].directAveragePriceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].isLikenessBased`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].requiresInventoryMapping`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].startHour`		`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].startHour.anyOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].startHour.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].confidence`	`string ["high","medium","developing"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].evidenceReasonCodes`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].evidenceReasonCodes[]`	`string ["history","likeness","supply","popularity"]`	`Non`
`$.oneOf[0].allOf[1].Payload.rows[].evidenceLabels`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].evidenceLabels[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.rows[].sourceMode`	`string ["direct","likeness","direct+likeness"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].sourceLocationIDs`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].sourceLocationIDs[]`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.averagePriceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.confidenceLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.recommendedListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.activeListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.neededListingCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.averagePriceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.recentViewCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.showByDefault`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.status`	`string ["room_for_supply","good_supply","oversupply","no_estimation"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.tone`	`string ["neutral","positive","warning"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.confidence`	`string ["high","medium","developing"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.reasonCodes`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.reasonCodes[]`	`string ["history","likeness","events","current_demand","popularity","supply","views"]`	`Non`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.reasonLabels`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.reasonLabels[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceConfidenceLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceBasisLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.isEstimatedPrice`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceConfidence`	`string ["high","medium","low","none"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.priceBasis`	`string ["direct_market","active_supply","related_market","related_country","comparable_sales","none"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.comparableSaleCount`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.isExactInventoryComparable`	`boolean`	`Non`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.relatedPriceLocationID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.rows[].supplyAssessment.relatedPriceLocationName`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.rows[].competition`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.count`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingID`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].locationAlias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].inventoryTypeName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingTimeLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingDateTimeLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].askingPriceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].inventoryTypeID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].askingPriceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingViewsOneDay`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingViewsAllTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingPopularityScoreBracket`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].isRequestingUserListing`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingStartHour`		`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingStartHour.anyOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].competition.listings[].listingStartHour.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].priceFormatted`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].priceConfidenceLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].priceBasisLabel`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].priceCents`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].isEstimatedPrice`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].priceConfidence`	`string ["high","medium","low","none"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].priceBasis`	`string ["direct_market","active_supply","related_market","related_country","comparable_sales","none"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.rows[].comparableSaleCount`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.rows[].isExactInventoryComparable`	`boolean`	`Non`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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": []
    }
}

Documentation du point de terminaison lisible par machine

GET

/v1/partner/get_location_likeness_group

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to inspect.

Exemple de requête (cURL)

curl --get \
  'https://fr.appointmenttrader.com/v1/partner/get_location_likeness_group' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_get_location_likeness_group_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.LocationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.ready`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.missingTables`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.missingTables[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.SelectedOptions`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].value`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].subtitle`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].keywords`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].alias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].name`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].cityLine`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].categoryName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].source`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].relationshipCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedLocationIDs`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedLocationIDs[]`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.SelectedAliases`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedAliases[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].value`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].subtitle`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].keywords`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].alias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].name`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].cityLine`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].categoryName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].source`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].relationshipCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.CanEdit`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.CanBulkAvailability`	`boolean`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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
    }
}

Documentation du point de terminaison lisible par machine

GET

/v1/partner/get_location_likeness_options

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Target location ID.
`q`	`string`	`Non`	`""`	Search query.
`pageSize`	`int`	`Non`	`15`	Maximum options to return.

Exemple de requête (cURL)

curl --get \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_get_location_likeness_options_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.options`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.options[].value`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].subtitle`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].keywords`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].alias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].name`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].cityLine`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].categoryName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].source`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.options[].relationshipCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.pageSize`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.query`	`string`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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"
    }
}

Documentation du point de terminaison lisible par machine

GET

/v1/partner/get_location_livestream

#

Get the featured livestream post for a managed venue.

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to inspect.

Exemple de requête (cURL)

curl --get \
  'https://fr.appointmenttrader.com/v1/partner/get_location_livestream' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_get_location_livestream_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Featured`		`Oui`
`$.oneOf[0].allOf[1].Payload.Featured.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postTitle`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].goLiveURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].liveStreamStartDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].boardName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].featuredLivestreamLinkID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].postAuthorUserID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Featured.anyOf[0].isLive`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.Featured.anyOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.ready`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.missingTables`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.missingTables[]`	`string`	`Non`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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": []
        }
    }
}

Documentation du point de terminaison lisible par machine

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.

Exemple de requête (cURL)

curl --get \
  'https://fr.appointmenttrader.com/v1/partner/get_locations' \
  --data-urlencode 'key={{API_KEY}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_get_locations_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.schema`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.schema.ready`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.schema.missingTables`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.schema.missingTables[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.locations`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.locations[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.locations[].name`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.locations[].alias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.locations[].cityLine`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.locations[].partnerAccountName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.locations[].role`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.locations[].source`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.locations[].managementURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.locations[].profileURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.locations[].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.locations[].partnerAccountID`		`Oui`
`$.oneOf[0].allOf[1].Payload.locations[].partnerAccountID.anyOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.locations[].partnerAccountID.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].name`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].alias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].cityLine`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].status`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].createdDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].chatURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].managementURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].profileURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].requestID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].chatID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationStatus`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationChatID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationChatURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationUnreadCount`		`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationUnreadCount.anyOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].applicationUnreadCount.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].sidebarStatus`		`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].sidebarStatus.anyOf[0]`	`string ["answer-required","pending"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.pendingRequests[].sidebarStatus.anyOf[1]`	`null`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/get_locations",
    "RequestUserAlias": "example-user",
    "Payload": {
        "schema": {
            "ready": false,
            "missingTables": []
        },
        "locations": [],
        "pendingRequests": []
    }
}

Documentation du point de terminaison lisible par machine

GET

/v1/partner/get_opening_hours

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to inspect.

Exemple de requête (cURL)

curl --get \
  'https://fr.appointmenttrader.com/v1/partner/get_opening_hours' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire	Description
`$`	`partner_get_opening_hours_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.schema`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.schema.ready`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.schema.missingTables`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.schema.missingTables[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.OpeningHours.source`	`string ["legacy","split"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.maxWindowsPerDay`	`= 4`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].key`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].humanReadable`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].weekday`	`integer`	`Oui`	Monday=0 through Sunday=6.
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].openTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].closeTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].closed`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[]`	`object`	`Non`	Times are integer HHMM; close <= open means the following day.
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].openTimeInput`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].closeTimeInput`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].id`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].openTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].closeTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.days[].windows[].overnight`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.OpeningHours.CanEdit`	`= true`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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
        }
    }
}

Documentation du point de terminaison lisible par machine

GET

/v1/partner/get_team

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to inspect.

Exemple de requête (cURL)

curl --get \
  'https://fr.appointmenttrader.com/v1/partner/get_team' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire	Description
`$`	`partner_get_team_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.partnerAccountID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.members`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.members[].ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Team.members[].ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].ATUser_ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Team.members[].ATUser_ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].ATUser_ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].Role`	`string ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].Status`	`= "Active"`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].CreatedDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].AcceptedDate`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].AcceptedDate.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].AcceptedDate.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].Alias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].Email`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].Email.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].Email.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].Avatar`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].actorUserID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].targetUserID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].isBlocked`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].blockedDate`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].blockedDate.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].blockedDate.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].isMuted`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].mutedDate`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].mutedDate.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].mutedDate.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].reason`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[0].personalNote`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.members[].relationshipControls.anyOf[1].personalNote`	`= ""`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.invites[].ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Team.invites[].ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].InviteToken`	`string`	`Oui`	Synthetic placeholder in documentation; runtime value is a private team invitation token.
`$.oneOf[0].allOf[1].Payload.Team.invites[].Role`	`string ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].InviteEmail`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].InviteEmail.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].InviteEmail.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].Status`	`string ["Pending","Accepted","Revoked","Expired"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].CreatedDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedBy-ATUser_ID.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedDate`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedDate.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].AcceptedDate.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].ExpiresDate`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].ExpiresDate.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].ExpiresDate.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].CreatedBy-ATUser_ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Team.invites[].CreatedBy-ATUser_ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.invites[].CreatedBy-ATUser_ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Team.audit[].ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].CreatedDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].Action`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].Actor-ATUser_ID.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].Target-ATUser_ID.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0]`	`string (application/json)`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0]`	`PartnerAuditContext (JSON décodé)`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].previousPolicy`	`string ["None","AllowAnyone","CurrentOwnerResellOnly"]`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].policy`	`string ["AllowAnyone","CurrentOwnerResellOnly"]`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].requestID`	`DatabaseInteger`	`Non`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].requestID.oneOf[0]`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].requestID.oneOf[1]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].locationIDs`	`array`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].locationIDs[]`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].count`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].dayCount`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].windowCount`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].reason`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].alreadyDeleted`	`boolean`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary.penaltyCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary.existingPenaltyCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary.pointsAmount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].penaltySummary.currencyAmount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inventoryTypeID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].postID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].createdPost`	`boolean`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].rowCount`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].createdCount`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].errorCount`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].appointmentIDs`	`array`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].appointmentIDs[]`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].role`	`string ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"]`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID`		`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID.anyOf[0]`	`DatabaseInteger`	`Non`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID.anyOf[0].oneOf[0]`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID.anyOf[0].oneOf[1]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].inviteID.anyOf[1]`	`boolean`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[0].email`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[0].anyOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ContextJSON.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ActorAlias`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ActorAlias.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].ActorAlias.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].TargetAlias`		`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].TargetAlias.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.Team.audit[].TargetAlias.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.ready`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.missingTables`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.missingTables[]`	`string`	`Non`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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": []
        }
    }
}

Documentation du point de terminaison lisible par machine

POST

/v1/partner/set_bulk_availability

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to manage.
`csvRows`	`string`	`Oui`	`—`	CSV rows using partner/get_bulk_availability_template.
`createMissingInventoryTypes`	`bool`	`Non`	`false`	Create unknown inventory types before writing rows.
`isWritingRequest`	`bool`	`Non`	`false`	Dry-run guard for writes.

Exemple de requête (cURL)

curl --request POST \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire	Description
`$`	`partner_set_bulk_availability_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].rowNumber`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].status`	`string ["valid","error","created"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].errors`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].errors[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.inventoryTypeName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.dateTime`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.currencyCode`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.firstName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.lastName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.emailAddress`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.phoneNumber`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.inventoryTypeID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.quantity`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.priceAmountInSmallestUnit`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.discussionPostID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.createInventoryType`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0]`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][]`	`PartnerImportJSONValue`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[0]`	`null`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[1]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[2]`	`number`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[3]`	`boolean`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4]`	`array`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4][]`	`PartnerImportJSONValue`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5].*`	`PartnerImportJSONValue`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*`	`PartnerImportJSONValue`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[0]`	`null`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[1]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[2]`	`number`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[3]`	`boolean`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4]`	`array`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4][]`	`PartnerImportJSONValue`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1]..anyOf[5].`	`PartnerImportJSONValue`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].appointmentIDs`	`array`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Rows[].appointmentIDs[]`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Summary`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.rowCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.validCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.errorCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.missingInventoryTypes`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Summary.missingInventoryTypes[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[0]`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[0].oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[0].oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].BatchID.anyOf[1]`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].rowNumber`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].status`	`string ["valid","error","created"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].errors`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].errors[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.inventoryTypeName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.dateTime`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.currencyCode`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.firstName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.lastName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.emailAddress`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.phoneNumber`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.inventoryTypeID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.quantity`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.priceAmountInSmallestUnit`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.discussionPostID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.createInventoryType`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0]`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][]`	`PartnerImportJSONValue`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[0]`	`null`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[1]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[2]`	`number`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[3]`	`boolean`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4]`	`array`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[4][]`	`PartnerImportJSONValue`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[0][].anyOf[5].*`	`PartnerImportJSONValue`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*`	`PartnerImportJSONValue`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[0]`	`null`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[1]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[2]`	`number`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[3]`	`boolean`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4]`	`array`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[4][]`	`PartnerImportJSONValue`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1].*.anyOf[5]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].normalized.locationCategoryFieldIDValueList.anyOf[1]..anyOf[5].`	`PartnerImportJSONValue`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].appointmentIDs`	`array`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Rows[].appointmentIDs[]`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Summary`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.rowCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.createdCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.errorCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.appointmentIDs`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Summary.appointmentIDs[]`	`integer`	`Non`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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": []
        }
    }
}

Documentation du point de terminaison lisible par machine

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.

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to delete.
`reason`	`string`	`Non`	`""`	Community-standards reason shown in audit and penalty ledger descriptions.
`confirmation`	`string`	`Non`	`""`	Type DELETE when isWritingRequest is true.
`isWritingRequest`	`bool`	`Non`	`false`	False returns a dry-run penalty preview; true soft-deletes and applies penalties.

Exemple de requête (cURL)

curl --request POST \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_set_delete_location_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].AlreadyDeleted`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].LocationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].LocationName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Succeeded`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.DryRun`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.LocationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.ProposalCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.penaltyCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.existingPenaltyCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.pointsAmount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Summary.currencyAmount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].role`	`string ["submitter","verifier"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].userID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].rewardLedgerID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].confirmationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].status`	`string ["reward-ledger-missing","reward-ledger-user-mismatch","already-penalized","pending","no-penalty-amount","account-missing","penalty-failed","penalized"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].penaltyLedgerID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].pointsAmount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].currencyAmount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].accountID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].penaltyMultiplier`	`number`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].proposalID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].locationID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].PenaltyPreview.Penalties[].locationName`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].DryRun`	`= false`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].AlreadyDeleted`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].LocationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].LocationName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Succeeded`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.DryRun`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.LocationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.ProposalCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.penaltyCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.existingPenaltyCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.pointsAmount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Summary.currencyAmount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].role`	`string ["submitter","verifier"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].userID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].rewardLedgerID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].confirmationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].status`	`string ["reward-ledger-missing","reward-ledger-user-mismatch","already-penalized","pending","no-penalty-amount","account-missing","penalty-failed","penalized"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].penaltyLedgerID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].pointsAmount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].currencyAmount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].accountID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].penaltyMultiplier`	`number`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].proposalID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].locationID`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PenaltyResult.Penalties[].locationName`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].RedirectURL`	`string`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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": []
        }
    }
}

Documentation du point de terminaison lisible par machine

POST

/v1/partner/set_inventory_type

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to manage.
`inventoryTypeID`	`int`	`Non`	`0`	Existing inventory type ID, or 0 to create one.
`name`	`string`	`Non`	`""`	Inventory type name.
`description`	`string`	`Non`	`""`	Short description.
`allowListings`	`bool`	`Non`	`true`	Whether sellers can create listings for this type.
`groupName`	`string`	`Non`	`""`	Optional group label.
`headcount`	`int`	`Non`	`0`	Optional default headcount.
`defaultBidAmount`	`int`	`Non`	`0`	Default bid amount in cents.
`defaultOfferAmount`	`int`	`Non`	`0`	Default offer amount in cents.
`isWritingRequest`	`bool`	`Non`	`false`	Dry-run guard for writes.

Exemple de requête (cURL)

curl --request POST \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_set_inventory_type_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].InventoryTypeID`	`integer`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_inventory_type",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}

Documentation du point de terminaison lisible par machine

POST

/v1/partner/set_inventory_type_post_link

#

Link a community post to a venue inventory type.

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to manage.
`inventoryTypeID`	`int`	`Oui`	`—`	Inventory type ID.
`discussionPostID`	`int`	`Oui`	`—`	Community post ID to link.
`isWritingRequest`	`bool`	`Non`	`false`	Dry-run guard for writes.

Exemple de requête (cURL)

curl --request POST \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_set_inventory_type_post_link_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`array`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_inventory_type_post_link",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}

Documentation du point de terminaison lisible par machine

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.

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to manage.
`policy`	`string`	`Oui`	`—`	One of AllowAnyone or CurrentOwnerResellOnly.
`isWritingRequest`	`bool`	`Non`	`false`	Dry-run guard for writes.

Exemple de requête (cURL)

curl --request POST \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_set_listing_regulation_policy_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].policy`	`string ["AllowAnyone","CurrentOwnerResellOnly"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].policy`	`string ["None","AllowAnyone","CurrentOwnerResellOnly"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].defaultPolicy`	`= "CurrentOwnerResellOnly"`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].canEdit`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].schema`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].schema.ready`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].schema.missingColumns`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].schema.missingColumns[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].options`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].options[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].options[].value`	`string ["AllowAnyone","CurrentOwnerResellOnly"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].options[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].restrictedByRegulation`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0].name`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0].effectiveDateStart`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[0].id`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].blockingRegulation.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Saved`	`= true`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_listing_regulation_policy",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true,
        "policy": "AllowAnyone"
    }
}

Documentation du point de terminaison lisible par machine

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.

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to claim.
`message`	`string`	`Non`	`""`	Optional claim note for reviewers.
`isWritingRequest`	`bool`	`Non`	`false`	Dry-run guard for writes.

Exemple de requête (cURL)

curl --request POST \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_set_location_claim_request_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].AlreadyManager`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ManagementURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].ChatURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].RequestID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].ChatID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Created`	`boolean`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_location_claim_request",
    "RequestUserAlias": "example-user",
    "Payload": {
        "AlreadyManager": true,
        "ManagementURL": "synthetic-example"
    }
}

Documentation du point de terminaison lisible par machine

POST

/v1/partner/set_location_likeness_group

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Target location ID.
`locationIDs`	`string`	`Non`	`""`	Comma-separated similar restaurant location IDs.
`isWritingRequest`	`bool`	`Non`	`false`	Dry-run guard for writes.

Exemple de requête (cURL)

curl --request POST \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_set_location_likeness_group_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.LocationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.ready`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.missingTables`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.Schema.missingTables[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.SelectedOptions`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].value`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].subtitle`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].keywords`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].alias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].name`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].cityLine`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].categoryName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].source`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedOptions[].relationshipCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedLocationIDs`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedLocationIDs[]`	`integer`	`Non`
`$.oneOf[0].allOf[1].Payload.SelectedAliases`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.SelectedAliases[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].value`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].subtitle`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].keywords`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].alias`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].name`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].cityLine`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].categoryName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].source`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.SuggestedOptions[].relationshipCount`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.CanEdit`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.CanBulkAvailability`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.SavedCount`	`integer`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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
    }
}

Documentation du point de terminaison lisible par machine

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.

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to manage.
`discussionPostID`	`int`	`Non`	`0`	Existing public top-level location post to feature. Use 0 when createPost is true.
`title`	`string`	`Non`	`""`	Optional title for a newly created station post.
`body`	`string`	`Non`	`""`	Optional body for a newly created station post.
`createPost`	`bool`	`Non`	`false`	Create a new location discussion post before featuring it.
`clear`	`bool`	`Non`	`false`	Remove the featured livestream post from the public location page.
`isWritingRequest`	`bool`	`Non`	`false`	Dry-run guard for writes.

Exemple de requête (cURL)

curl --request POST \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_set_location_livestream_post_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Featured`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].DiscussionPostID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postTitle`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].goLiveURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].liveStreamStartDate`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].boardName`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].featuredLivestreamLinkID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].locationID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].postAuthorUserID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[0].isLive`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Featured.anyOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].PostURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].GoLiveURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].DryRun`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].WouldCreatePost`	`= true`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[2].DiscussionPostID`	`integer`	`Non`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_location_livestream_post",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Featured": []
    }
}

Documentation du point de terminaison lisible par machine

POST

/v1/partner/set_opening_hours

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to manage.
`hoursJSON`	`string`	`Non`	`""`	JSON payload with days, closed flags, and open/close windows.
`isWritingRequest`	`bool`	`Non`	`false`	Dry-run guard for writes.

Exemple de requête (cURL)

curl --request POST \
  'https://fr.appointmenttrader.com/v1/partner/set_opening_hours' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationID={{locationID}}' \
  --data-urlencode 'hoursJSON={{hoursJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retour

JSON

See the shared response schema and synthetic example.

Paramètres: hoursJSON

Champ	Type	Obligatoire	Description
`hoursJSON`	`string (application/json)`	`Non`
`hoursJSON`	`PartnerOpeningHoursInput (JSON décodé)`	`Non`	Omitted weekdays are closed. A non-closed day needs 1â€“4 non-overlapping windows; weekday may be explicit or the zero-based list/key index.
`hoursJSON.anyOf[0]`	`object`	`Non`
`hoursJSON.anyOf[0].days`		`Oui`
`hoursJSON.anyOf[0].days.anyOf[0]`	`array`	`Oui`
`hoursJSON.anyOf[0].days.anyOf[0][]`	`object`	`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].weekday`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].closed`	`boolean`	`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows`	`array`	`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[]`	`object`	`Non`	Supply one opening and one closing alias. They must differ; overnight windows are supported. Windows cannot overlap or repeat.
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTime`		`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].open`		`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].open.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].open.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].OpenTime`		`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].OpenTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].OpenTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTimeInput`		`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTimeInput.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].openTimeInput.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTime`		`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].close`		`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].close.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].close.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].CloseTime`		`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].CloseTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].CloseTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTimeInput`		`Non`
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTimeInput.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[0][].windows[].closeTimeInput.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[1]`	`object`	`Oui`
`hoursJSON.anyOf[0].days.anyOf[1].*`	`object`	`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.weekday`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.closed`	`boolean`	`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows`	`array`	`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[]`	`object`	`Non`	Supply one opening and one closing alias. They must differ; overnight windows are supported. Windows cannot overlap or repeat.
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTime`		`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].open`		`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].open.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].open.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].OpenTime`		`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].OpenTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].OpenTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTimeInput`		`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTimeInput.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].openTimeInput.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTime`		`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].close`		`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].close.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].close.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].CloseTime`		`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].CloseTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].CloseTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTimeInput`		`Non`
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTimeInput.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[0].days.anyOf[1].*.windows[].closeTimeInput.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1]`		`Non`
`hoursJSON.anyOf[1].anyOf[0]`	`array`	`Non`
`hoursJSON.anyOf[1].anyOf[0][]`	`object`	`Non`
`hoursJSON.anyOf[1].anyOf[0][].weekday`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[0][].closed`	`boolean`	`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows`	`array`	`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[]`	`object`	`Non`	Supply one opening and one closing alias. They must differ; overnight windows are supported. Windows cannot overlap or repeat.
`hoursJSON.anyOf[1].anyOf[0][].windows[].openTime`		`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].openTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[0][].windows[].openTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].open`		`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].open.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[0][].windows[].open.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].OpenTime`		`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].OpenTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[0][].windows[].OpenTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].openTimeInput`		`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].openTimeInput.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[0][].windows[].openTimeInput.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].closeTime`		`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].closeTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[0][].windows[].closeTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].close`		`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].close.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[0][].windows[].close.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].CloseTime`		`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].CloseTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[0][].windows[].CloseTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].closeTimeInput`		`Non`
`hoursJSON.anyOf[1].anyOf[0][].windows[].closeTimeInput.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[0][].windows[].closeTimeInput.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[1]`	`object`	`Non`
`hoursJSON.anyOf[1].anyOf[1].*`	`object`	`Non`
`hoursJSON.anyOf[1].anyOf[1].*.weekday`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[1].*.closed`	`boolean`	`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows`	`array`	`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[]`	`object`	`Non`	Supply one opening and one closing alias. They must differ; overnight windows are supported. Windows cannot overlap or repeat.
`hoursJSON.anyOf[1].anyOf[1].*.windows[].openTime`		`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].openTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[1].*.windows[].openTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].open`		`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].open.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[1].*.windows[].open.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].OpenTime`		`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].OpenTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[1].*.windows[].OpenTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].openTimeInput`		`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].openTimeInput.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[1].*.windows[].openTimeInput.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTime`		`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].close`		`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].close.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[1].*.windows[].close.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].CloseTime`		`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].CloseTime.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[1].*.windows[].CloseTime.anyOf[1]`	`integer`	`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTimeInput`		`Non`
`hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTimeInput.anyOf[0]`	`string`	`Non`	HH:MM, a numeric hour, or numeric HHMM.
`hoursJSON.anyOf[1].anyOf[1].*.windows[].closeTimeInput.anyOf[1]`	`integer`	`Non`

Champs de réponse

Champ	Type	Obligatoire	Description
`$`	`partner_set_opening_hours_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].key`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].humanReadable`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].weekday`	`integer`	`Oui`	Monday=0 through Sunday=6.
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].openTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].closeTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].closed`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[]`	`object`	`Non`	Times are integer HHMM; close <= open means the following day.
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].openTimeInput`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].closeTimeInput`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].id`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].openTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].closeTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].days[].windows[].overnight`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].rows`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].rows[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].Weekday`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].OpenTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].CloseTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].rows[].SortOrder`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema.ready`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema.missingTables`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.schema.missingTables[]`	`string`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.source`	`string ["legacy","split"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.maxWindowsPerDay`	`= 4`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[]`	`object`	`Non`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].key`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].humanReadable`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].weekday`	`integer`	`Oui`	Monday=0 through Sunday=6.
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].openTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].closeTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].closed`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows`	`array`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[]`	`object`	`Non`	Times are integer HHMM; close <= open means the following day.
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].openTimeInput`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].closeTimeInput`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].label`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].id`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].openTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].closeTime`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].OpeningHours.days[].windows[].overnight`	`boolean`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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": []
    }
}

Documentation du point de terminaison lisible par machine

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.

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Non`	`0`	Location ID for the invite.
`role`	`string`	`Non`	`"Analyst"`	One of Owner, Admin, InventoryManager, HostSupport, Finance, Analyst.
`email`	`string`	`Non`	`""`	Optional invite email annotation.
`inviteToken`	`string`	`Non`	`""`	Existing invite token to accept instead of creating a new invite.
`acceptInvite`	`bool`	`Non`	`false`	Accept inviteToken for the signed-in user.
`isWritingRequest`	`bool`	`Non`	`false`	Dry-run guard for writes.

Exemple de requête (cURL)

curl --request POST \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire	Description
`$`	`partner_set_team_invite_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[0]`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[0].oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[0].oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].InviteID.anyOf[1]`	`boolean`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].InviteURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].Role`	`string ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].DryRun`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].InviteURL`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Role`	`string ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATPartnerAccount_ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATPartnerAccount_ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATPartnerAccount_ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[0]`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[0].oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[0].oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ATLocation_ID.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteToken`	`string`	`Oui`	Synthetic placeholder in documentation; runtime value is a private team invitation token.
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.Role`	`string ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"]`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteEmail`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteEmail.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.InviteEmail.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.Status`	`= "Pending"`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.CreatedBy-ATUser_ID`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.CreatedBy-ATUser_ID.oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.CreatedBy-ATUser_ID.oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Oui`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedBy-ATUser_ID.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedDate`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedDate.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.AcceptedDate.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ExpiresDate`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ExpiresDate.anyOf[0]`	`string`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].Invite.ExpiresDate.anyOf[1]`	`null`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[2].DryRun`	`= true`	`Non`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "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"
    }
}

Documentation du point de terminaison lisible par machine

POST

/v1/partner/set_team_member_remove

#

Remove a user from a venue team.

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to manage.
`userID`	`int`	`Oui`	`—`	Team member user ID to remove.
`isWritingRequest`	`bool`	`Non`	`false`	Dry-run guard for writes.

Exemple de requête (cURL)

curl --request POST \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_set_team_member_remove_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`array`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_team_member_remove",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}

Documentation du point de terminaison lisible par machine

POST

/v1/partner/set_team_member_role

#

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

Paramètres

Nom	Type	Obligatoire	Valeur par défaut	Description
`locationID`	`int`	`Oui`	`—`	Location ID to manage.
`aliasOrEmail`	`string`	`Oui`	`—`	Existing user's alias or email.
`role`	`string`	`Oui`	`—`	One of Owner, Admin, InventoryManager, HostSupport, Finance, Analyst.
`isWritingRequest`	`bool`	`Non`	`false`	Dry-run guard for writes.

Exemple de requête (cURL)

curl --request POST \
  'https://fr.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}}'

Retour

JSON

See the shared response schema and synthetic example.

Champs de réponse

Champ	Type	Obligatoire
`$`	`partner_set_team_member_role_Response`	`Oui`
`$.oneOf[0]`		`Oui`
`$.oneOf[0].allOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Oui`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Oui`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Oui`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Non`
`$.oneOf[0].allOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload`		`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[0].DryRun`	`= true`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`object`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].UserID`	`integer`	`Oui`
`$.oneOf[0].allOf[1].Payload.anyOf[1].Role`	`string ["Owner","Admin","InventoryManager","HostSupport","Finance","Analyst"]`	`Oui`
`$.oneOf[1]`	`object`	`Oui`
`$.oneOf[1].RequestUserAlias`	`string`	`Oui`
`$.oneOf[1].RequestPath`	`string \| null`	`Oui`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Oui`
`$.oneOf[1].ResponseCode`	`integer`	`Oui`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Non`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Oui`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Non`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Non`

Exemple de réponse

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/partner/set_team_member_role",
    "RequestUserAlias": "example-user",
    "Payload": {
        "DryRun": true
    }
}

Documentation du point de terminaison lisible par machine