{"items":[{"type":"link","label":"Contracting API","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","content":{"contentType":"overview","meta":{"name":"Contracting API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"contracting-api-specificaion.json","url":"/_bundle/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion.json?download"},{"kind":"download","label":"contracting-api-specificaion.yaml","url":"/_bundle/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Contracting API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Contracting API to invite a new partner on Booking.com, check whether a partner has signed the contract, resend invitation mail and retrieve the legal entity of the partner."},"children":[]}]}]}]}],"sectionId":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion"}],"sectionId":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Contracting API supports token-based authentication. Each request must have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header containing a JWT token. Manage your machine accounts in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.booking.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connectivity Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See also the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/connectivity/docs/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication page"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the documentation."},"children":[]}]}]}]}],"sectionId":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/message-formats"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message formats"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Contracting API accepts and returns JSON."},"children":[]}]}]}]}],"sectionId":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/section/message-formats"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/documentation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/connectivity/docs/contracting-api/understanding-the-contracting-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contracting API documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details about working with this API."},"children":[]}]}]}]}],"sectionId":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/section/documentation"}]}]}},{"type":"link","label":"Authentication","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/section/authentication","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/section/authentication","content":null},{"type":"link","label":"Message formats","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/section/message-formats","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/section/message-formats","content":null},{"type":"link","label":"Documentation","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/section/documentation","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/section/documentation","content":null},{"type":"separator","label":"API Endpoints","content":null},{"type":"group","label":"Manage contracts","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/manage-contracts","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/manage-contracts","items":[{"label":"Create a contract and legal entity ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/manage-contracts/postpartnersinvite","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/manage-contracts/postpartnersinvite","metadata":{"seo":{"title":"Create a contract and legal entity ID","description":"Use this endpoint to create a partner card for a new partner and invite them to sign a contract with Booking.com"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPartnersInvite","name":"Create a contract and legal entity ID","isWebhook":false,"pointer":"/paths/~1partners~1invite/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a contract and legal entity ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to create a partner card for a new partner and invite them to sign a contract with Booking.com"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_368"}],"pointer":"/paths/~1partners~1invite/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369","exampleIds":["paths/~1partners~1invite/post/requestBody/content/application~1json/examples/create a test partner"]}},"schemaId":"schema_369","exampleIds":["paths/~1partners~1invite/post/requestBody/content/application~1json/examples/create a test partner"],"pointer":"/paths/~1partners~1invite/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/partners/invite","servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":false,"schemaId":"schema_368"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_369","exampleIds":["paths/~1partners~1invite/post/requestBody/content/application~1json/examples/create a test partner"]}},"responseCodes":["200","201","400","401","500"],"pointer":"/partners/invite","href":"manage-contracts/postpartnersinvite","openApiOperationId":"postPartnersInvite","summary":"Create a contract and legal entity ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"schemaId":"schema_369","exampleIds":["paths/~1partners~1invite/post/requestBody/content/application~1json/examples/create a test partner"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369","exampleIds":["paths/~1partners~1invite/post/requestBody/content/application~1json/examples/create a test partner"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1partners~1invite/post/responses/200/content/application~1json/examples/success"]}},"schemaId":"schema_370","exampleIds":["paths/~1partners~1invite/post/responses/200/content/application~1json/examples/success"]},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371","exampleIds":["paths/~1partners~1invite/post/responses/201/content/application~1json/examples/success"]}},"schemaId":"schema_371","exampleIds":["paths/~1partners~1invite/post/responses/201/content/application~1json/examples/success"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"}],"pointer":"/paths/~1partners~1invite/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_370","exampleIds":["paths/~1partners~1invite/post/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1partners~1invite/post/responses/200/content/application~1json/examples/success"]}}},{"code":"201","schemaId":"schema_371","exampleIds":["paths/~1partners~1invite/post/responses/201/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371","exampleIds":["paths/~1partners~1invite/post/responses/201/content/application~1json/examples/success"]}}},{"code":"400","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"401","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"500","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}}],"examples":[]}]}]}]},"httpPath":"/partners/invite"},{"label":"Update an existing contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/manage-contracts/postpartnersaddendum","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/manage-contracts/postpartnersaddendum","metadata":{"seo":{"title":"Update an existing contract","description":"Use this endpoint to send addendum to the partner to add more countries where properties can be listed, only if partner has already a signed contract with Booking.com."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPartnersAddendum","name":"Update an existing contract","isWebhook":false,"pointer":"/paths/~1partners~1addendum/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to send addendum to the partner to add more countries where properties can be listed, only if partner has already a signed contract with Booking.com."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_368"}],"pointer":"/paths/~1partners~1addendum/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_373","exampleIds":["paths/~1partners~1addendum/post/requestBody/content/application~1json/examples/add countries to partner"]}},"schemaId":"schema_373","exampleIds":["paths/~1partners~1addendum/post/requestBody/content/application~1json/examples/add countries to partner"],"pointer":"/paths/~1partners~1addendum/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/partners/addendum","servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":false,"schemaId":"schema_368"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_373","exampleIds":["paths/~1partners~1addendum/post/requestBody/content/application~1json/examples/add countries to partner"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/partners/addendum","href":"manage-contracts/postpartnersaddendum","openApiOperationId":"postPartnersAddendum","summary":"Update an existing contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"schemaId":"schema_373","exampleIds":["paths/~1partners~1addendum/post/requestBody/content/application~1json/examples/add countries to partner"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_373","exampleIds":["paths/~1partners~1addendum/post/requestBody/content/application~1json/examples/add countries to partner"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374","exampleIds":["paths/~1partners~1addendum/post/responses/200/content/application~1json/examples/Signed contract - add countries","paths/~1partners~1addendum/post/responses/200/content/application~1json/examples/Unsigned contract - add countries"]}},"schemaId":"schema_374","exampleIds":["paths/~1partners~1addendum/post/responses/200/content/application~1json/examples/Signed contract - add countries","paths/~1partners~1addendum/post/responses/200/content/application~1json/examples/Unsigned contract - add countries"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"}],"pointer":"/paths/~1partners~1addendum/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_374","exampleIds":["paths/~1partners~1addendum/post/responses/200/content/application~1json/examples/Signed contract - add countries","paths/~1partners~1addendum/post/responses/200/content/application~1json/examples/Unsigned contract - add countries"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374","exampleIds":["paths/~1partners~1addendum/post/responses/200/content/application~1json/examples/Signed contract - add countries","paths/~1partners~1addendum/post/responses/200/content/application~1json/examples/Unsigned contract - add countries"]}}},{"code":"400","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"401","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"404","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"500","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}}],"examples":[]}]}]}]},"httpPath":"/partners/addendum"},{"label":"Resend contract details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/manage-contracts/postpartnersresendinvite","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/manage-contracts/postpartnersresendinvite","metadata":{"seo":{"title":"Resend contract details","description":"Use this endpoint to resend the invitation email to the partner's registered contract email address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPartnersResendInvite","name":"Resend contract details","isWebhook":false,"pointer":"/paths/~1partners~1resend-invite/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend contract details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to resend the invitation email to the partner's registered contract email address."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_375","exampleIds":["paths/~1partners~1resend-invite/post/requestBody/content/application~1json/examples/resend invitation"]}},"schemaId":"schema_375","exampleIds":["paths/~1partners~1resend-invite/post/requestBody/content/application~1json/examples/resend invitation"],"pointer":"/paths/~1partners~1resend-invite/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/partners/resend-invite","servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_375","exampleIds":["paths/~1partners~1resend-invite/post/requestBody/content/application~1json/examples/resend invitation"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/partners/resend-invite","href":"manage-contracts/postpartnersresendinvite","openApiOperationId":"postPartnersResendInvite","summary":"Resend contract details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"schemaId":"schema_375","exampleIds":["paths/~1partners~1resend-invite/post/requestBody/content/application~1json/examples/resend invitation"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_375","exampleIds":["paths/~1partners~1resend-invite/post/requestBody/content/application~1json/examples/resend invitation"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_376","exampleIds":["paths/~1partners~1resend-invite/post/responses/200/content/application~1json/examples/success"]}},"schemaId":"schema_376","exampleIds":["paths/~1partners~1resend-invite/post/responses/200/content/application~1json/examples/success"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"}],"pointer":"/paths/~1partners~1resend-invite/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_376","exampleIds":["paths/~1partners~1resend-invite/post/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_376","exampleIds":["paths/~1partners~1resend-invite/post/responses/200/content/application~1json/examples/success"]}}},{"code":"400","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"401","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"404","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"500","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}}],"examples":[]}]}]}]},"httpPath":"/partners/resend-invite"},{"label":"Resend updated contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/manage-contracts/postpartnersresendaddendum","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/manage-contracts/postpartnersresendaddendum","metadata":{"seo":{"title":"Resend updated contract","description":"Use this endpoint to resend addendum to the partner to add more countries where properties can be listed, only if partner has already a signed contract with Booking.com."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPartnersResendAddendum","name":"Resend updated contract","isWebhook":false,"pointer":"/paths/~1partners~1resend-addendum/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend updated contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to resend addendum to the partner to add more countries where properties can be listed, only if partner has already a signed contract with Booking.com."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_377","exampleIds":["paths/~1partners~1resend-addendum/post/requestBody/content/application~1json/examples/resend addendum"]}},"schemaId":"schema_377","exampleIds":["paths/~1partners~1resend-addendum/post/requestBody/content/application~1json/examples/resend addendum"],"pointer":"/paths/~1partners~1resend-addendum/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/partners/resend-addendum","servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_377","exampleIds":["paths/~1partners~1resend-addendum/post/requestBody/content/application~1json/examples/resend addendum"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/partners/resend-addendum","href":"manage-contracts/postpartnersresendaddendum","openApiOperationId":"postPartnersResendAddendum","summary":"Resend updated contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"schemaId":"schema_377","exampleIds":["paths/~1partners~1resend-addendum/post/requestBody/content/application~1json/examples/resend addendum"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_377","exampleIds":["paths/~1partners~1resend-addendum/post/requestBody/content/application~1json/examples/resend addendum"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374","exampleIds":["paths/~1partners~1resend-addendum/post/responses/200/content/application~1json/examples/success"]}},"schemaId":"schema_374","exampleIds":["paths/~1partners~1resend-addendum/post/responses/200/content/application~1json/examples/success"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"}],"pointer":"/paths/~1partners~1resend-addendum/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_374","exampleIds":["paths/~1partners~1resend-addendum/post/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374","exampleIds":["paths/~1partners~1resend-addendum/post/responses/200/content/application~1json/examples/success"]}}},{"code":"400","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"401","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"404","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"500","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}}],"examples":[]}]}]}]},"httpPath":"/partners/resend-addendum"}],"content":{"contentType":"group","meta":{"name":"Manage contracts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manage contracts","showPageActions":true},{"nodeType":"markdoc","content":"Create, update or resend contract details."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/partners/invite","summary":"Create a contract and legal entity ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-contracts/postpartnersinvite","deprecated":false},{"title":"/partners/addendum","summary":"Update an existing contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-contracts/postpartnersaddendum","deprecated":false},{"title":"/partners/resend-invite","summary":"Resend contract details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-contracts/postpartnersresendinvite","deprecated":false},{"title":"/partners/resend-addendum","summary":"Resend updated contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-contracts/postpartnersresendaddendum","deprecated":false}]}]}]}]}},{"type":"group","label":"Check legal details","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/check-legal-details","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/check-legal-details","items":[{"label":"Check Partner legal details with email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/check-legal-details/postpartnerslegaldetails","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/check-legal-details/postpartnerslegaldetails","metadata":{"seo":{"title":"Check Partner legal details with email","description":"Use this endpoint to check the details of Partner within Booking.com for the mentioned partner email ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPartnersLegalDetails","name":"Check Partner legal details with email","isWebhook":false,"pointer":"/paths/~1partners~1legal-details/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check Partner legal details with email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to check the details of Partner within Booking.com for the mentioned partner email ID"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_368"}],"pointer":"/paths/~1partners~1legal-details/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_378","exampleIds":["paths/~1partners~1legal-details/post/requestBody/content/application~1json/examples/check legal details"]}},"schemaId":"schema_378","exampleIds":["paths/~1partners~1legal-details/post/requestBody/content/application~1json/examples/check legal details"],"pointer":"/paths/~1partners~1legal-details/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/partners/legal-details","servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":false,"schemaId":"schema_368"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_378","exampleIds":["paths/~1partners~1legal-details/post/requestBody/content/application~1json/examples/check legal details"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/partners/legal-details","href":"check-legal-details/postpartnerslegaldetails","openApiOperationId":"postPartnersLegalDetails","summary":"Check Partner legal details with email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"schemaId":"schema_378","exampleIds":["paths/~1partners~1legal-details/post/requestBody/content/application~1json/examples/check legal details"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_378","exampleIds":["paths/~1partners~1legal-details/post/requestBody/content/application~1json/examples/check legal details"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379","exampleIds":["paths/~1partners~1legal-details/post/responses/200/content/application~1json/examples/success"]}},"schemaId":"schema_379","exampleIds":["paths/~1partners~1legal-details/post/responses/200/content/application~1json/examples/success"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"}],"pointer":"/paths/~1partners~1legal-details/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_379","exampleIds":["paths/~1partners~1legal-details/post/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379","exampleIds":["paths/~1partners~1legal-details/post/responses/200/content/application~1json/examples/success"]}}},{"code":"400","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"401","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"404","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"500","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}}],"examples":[]}]}]}]},"httpPath":"/partners/legal-details"},{"label":"Check Partner legal details with entity ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/check-legal-details/getpartnerslegaldetailslegalentitybyid","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/check-legal-details/getpartnerslegaldetailslegalentitybyid","metadata":{"seo":{"title":"Check Partner legal details with entity ID","description":"Use this endpoint to check the details of Partner within Booking.com for the given legal entity ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPartnersLegalDetailsLegalEntityById","name":"Check Partner legal details with entity ID","isWebhook":false,"pointer":"/paths/~1partners~1legal-details~1legal-entity~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check Partner legal details with entity ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to check the details of Partner within Booking.com for the given legal entity ID."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_380","description":"Legal entity ID of the partner. This is treated as the unique identifier for the partner.","required":true}],"pointer":"/paths/~1partners~1legal-details~1legal-entity~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/partners/legal-details/legal-entity/{id}","servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_380"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/partners/legal-details/legal-entity/{id}","href":"check-legal-details/getpartnerslegaldetailslegalentitybyid","openApiOperationId":"getPartnersLegalDetailsLegalEntityById","summary":"Check Partner legal details with entity ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379","exampleIds":["paths/~1partners~1legal-details~1legal-entity~1{id}/get/responses/200/content/application~1json/examples/success"]}},"schemaId":"schema_379","exampleIds":["paths/~1partners~1legal-details~1legal-entity~1{id}/get/responses/200/content/application~1json/examples/success"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"}],"pointer":"/paths/~1partners~1legal-details~1legal-entity~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_379","exampleIds":["paths/~1partners~1legal-details~1legal-entity~1{id}/get/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379","exampleIds":["paths/~1partners~1legal-details~1legal-entity~1{id}/get/responses/200/content/application~1json/examples/success"]}}},{"code":"400","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"401","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"404","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"500","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}}],"examples":[]}]}]}]},"httpPath":"/partners/legal-details/legal-entity/{id}"}],"content":{"contentType":"group","meta":{"name":"Check legal details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check legal details","showPageActions":true},{"nodeType":"markdoc","content":"Check legal details of Partner using email or entity ID."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/partners/legal-details","summary":"Check Partner legal details with email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/check-legal-details/postpartnerslegaldetails","deprecated":false},{"title":"/partners/legal-details/legal-entity/{id}","summary":"Check Partner legal details with entity ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/check-legal-details/getpartnerslegaldetailslegalentitybyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Request access","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/request-access","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/request-access","items":[{"label":"Request access to existing partner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/request-access/postpartnersrequestaccess","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/request-access/postpartnersrequestaccess","metadata":{"seo":{"title":"Request access to existing partner","description":"Use this endpoint to request access to an existing partner of Booking.com"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPartnersRequestAccess","name":"Request access to existing partner","isWebhook":false,"pointer":"/paths/~1partners~1request_access/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request access to existing partner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to request access to an existing partner of Booking.com"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_368"}],"pointer":"/paths/~1partners~1request_access/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_381","exampleIds":["paths/~1partners~1request_access/post/requestBody/content/application~1json/examples/request access"]}},"schemaId":"schema_381","exampleIds":["paths/~1partners~1request_access/post/requestBody/content/application~1json/examples/request access"],"pointer":"/paths/~1partners~1request_access/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/partners/request_access","servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":false,"schemaId":"schema_368"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_381","exampleIds":["paths/~1partners~1request_access/post/requestBody/content/application~1json/examples/request access"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/partners/request_access","href":"request-access/postpartnersrequestaccess","openApiOperationId":"postPartnersRequestAccess","summary":"Request access to existing partner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","description":"Mock (schema only)","isMockServer":true},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}],"schemaId":"schema_381","exampleIds":["paths/~1partners~1request_access/post/requestBody/content/application~1json/examples/request access"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_381","exampleIds":["paths/~1partners~1request_access/post/requestBody/content/application~1json/examples/request access"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382","exampleIds":["paths/~1partners~1request_access/post/responses/200/content/application~1json/examples/success"]}},"schemaId":"schema_382","exampleIds":["paths/~1partners~1request_access/post/responses/200/content/application~1json/examples/success"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372","exampleIds":["paths/~1partners~1request_access/post/responses/400/content/application~1json/examples/partner already connected"]}},"schemaId":"schema_372","exampleIds":["paths/~1partners~1request_access/post/responses/400/content/application~1json/examples/partner already connected"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"}],"pointer":"/paths/~1partners~1request_access/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_382","exampleIds":["paths/~1partners~1request_access/post/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382","exampleIds":["paths/~1partners~1request_access/post/responses/200/content/application~1json/examples/success"]}}},{"code":"400","schemaId":"schema_372","exampleIds":["paths/~1partners~1request_access/post/responses/400/content/application~1json/examples/partner already connected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372","exampleIds":["paths/~1partners~1request_access/post/responses/400/content/application~1json/examples/partner already connected"]}}},{"code":"401","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"404","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"500","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}}],"examples":[]}]}]}]},"httpPath":"/partners/request_access"}],"content":{"contentType":"group","meta":{"name":"Request access"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request access","showPageActions":true},{"nodeType":"markdoc","content":"Request access to existing partner."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/partners/request_access","summary":"Request access to existing partner","prefix":{"name":"post","color":"post"},"badges":[],"link":"/request-access/postpartnersrequestaccess","deprecated":false}]}]}]}]}},{"type":"separator","label":"Documentation","content":null},{"type":"group","label":"About Try it","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it","items":[{"type":"link","label":"Environment","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/environment","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/environment","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Environment"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/environment"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can select between two different environments (top right corner in the UI):"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mock (schema only)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Helps to understand the response data schema"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for all write operations (POST, PUT, DELETE)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment for testing without affecting live/test data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test live endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make sure to use only test properties."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes will affect your test property data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires valid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same API structure as production"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Request","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/request","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/request","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Request"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/request"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can click on any unresolved placeholders to add a value or edit an existing placeholder value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portal loads the default request body. Where the specification supports multiple request body examples (for example: Rooms API POST endpoint), you can choose a different request body from the drop-down list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some helpful pointers before running a request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (when using live endpoint): Configure your authentication headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Key or OAuth token as required. Use the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make sure to manage separate machine accounts for test vs. properties in production."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure credentials match your selected environment."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fill in required parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path parameters (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST/PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to send the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request is sent to the selected environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When sending requests to the live endpoint, real HTTP request is made to the API"},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Response","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/response","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/response","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Response"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Try it feature provides comprehensive response information to the extent supported by the Open API specification:"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Status code","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/status-code","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/status-code","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Status code"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/status-code"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status code"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2xx"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Success responses (200)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4xx"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Client errors (400 Bad Request, 401 Unauthorized, 404 Not Found)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5xx"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Server errors (500 Internal Server Error)"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Response body","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/response-body","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/response-body","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Response body"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/response-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response body"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON formatted response data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the returned response, by default, is unformatted, select the supported Response body format in the UI."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Response headers","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/response-headers","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/response-headers","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Response headers"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/response-headers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type, Content-Length."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Environments","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/environments","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/environments","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Environments"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab allows you to create variables specific to the environment. For example, you can add a variable to hold the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder. The portal inserts the respective value depending on the environment at the time of sending the request."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Variables","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/variables","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/variables","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Variables"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/variables"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most of the endpoints (especially POST/PUT/DELETE) require you to add a path or query parameter before sending the request. The Open API specification marks these parameters with placeholder tags. For example, {{"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}. You can use the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab to manage the values for these placeholders as variables."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Path parameters","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/path-parameters","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/path-parameters","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Path parameters"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"about-try-it/path-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Must be provided to make the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type validation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Ensures correct data types (integer, string, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/charges-api/properties/{propertyId}/charges"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Query parameters","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/query-parameters","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/query-parameters","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Query parameters"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"about-try-it/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Usually have default values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-us"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the default value"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Request body","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/request-body","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/request-body","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Request body"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"about-try-it/request-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema validation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Follows OpenAPI schema definitions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Prepopulated with sample values"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Best practices","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/best-practices","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/best-practices","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Best practices"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/best-practices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best practices"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section provides some basic practice guidelines."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Authentication","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/authentication","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/authentication","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always use separate machine accounts for test properties vs. properties in production."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When testing with production endpoint, make sure to use only test properties."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"For Read operations (GET)","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/for-read-operations-(get)","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/for-read-operations-(get)","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"For Read operations (GET)"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/for-read-operations-(get)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Read operations (GET)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Safe to test in any environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use valid IDs that exist in your system"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check response structure for integration planning"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"For Write operations (POST, PUT)","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/for-write-operations-(post-put)","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/for-write-operations-(post-put)","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"For Write operations (POST, PUT)"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/for-write-operations-(post-put)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Write operations (POST, PUT)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always use Mock (schema only) environment first"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify request payload structure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check response for success confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test error scenarios with invalid data"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"For Delete operations (DELETE)","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/for-delete-operations-(delete)","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/for-delete-operations-(delete)","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"For Delete operations (DELETE)"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/for-delete-operations-(delete)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Delete operations (DELETE)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferable to use Mock (schema only) environment only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Understand the operation is irreversible"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have backup data when testing using test properties"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Troubleshooting","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/troubleshooting","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/troubleshooting","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Troubleshooting"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/troubleshooting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Troubleshooting"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Common issues","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/common-issues","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/common-issues","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Common issues"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/common-issues"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common issues"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check authentication credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify API key is valid and not expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure credentials match the selected environment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate request payload against schema"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check required fields are provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify data types match specification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Not Found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm the resource ID exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the endpoint URL is correct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify you have access to the resource"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Getting help","link":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/getting-help","routeSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion/about-try-it/getting-help","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Getting help"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/getting-help"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting help"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you encounter issues:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the response error message for details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify your request matches the API specification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact the Connectivity Team for support"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This documentation applies to all endpoints in the Charges API. The Try it feature provides a consistent testing experience across all operations."},"children":[]}]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"About Try it"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"About Try it","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn how to effectively use the Try it feature in the Contracting API documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to send sample requests to API endpoints directly from the developer portal. In the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mock (schema only)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment, Try it returns schema-driven mock responses or pre-built example responses. In the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment, it sends the request to the live API and returns dynamic responses from your selected test property."},"children":[]}]}]}]}],"panels":[]}]}}],"store":{"schemaStore":{"components/schemas/AddendumObject":{"id":"components/schemas/AddendumObject","kind":"json-schema","title":"AddendumObject","data":{"properties":{"status":{"description":"Status message indicating whether the addendum email was sent successfully.","example":"Addendum invitation sent to Partner.","type":"string"},"success":{"description":"A flag that indicates if the operation finished successfully.","example":1,"format":"int32","type":"integer"}},"required":["status","success"],"type":"object"}},"components/schemas/DiagnosisList":{"id":"components/schemas/DiagnosisList","kind":"json-schema","title":"DiagnosisList","data":{"items":{"properties":{"code":{"description":"Alphanumeric identifier for warning/error.","type":"string"},"details":{"additionalProperties":{"type":"string"},"description":"Additional details of warning/error.","type":"object"},"message":{"description":"English-language description of warning/error.","type":"string"}},"required":["code","details","message"],"type":"object"},"type":"array"}},"components/schemas/InvitedPartnerObject":{"id":"components/schemas/InvitedPartnerObject","kind":"json-schema","title":"InvitedPartnerObject","data":{"properties":{"legal_entity_id":{"description":"The unique legal entity ID of the partner.","example":22567,"format":"int32","type":"integer"}},"required":["legal_entity_id"],"type":"object"}},"components/schemas/PartnerDetailsObject":{"id":"components/schemas/PartnerDetailsObject","kind":"json-schema","title":"PartnerDetailsObject","data":{"properties":{"city":{"description":"City name of the partner company.","example":"Amsterdam","type":"string"},"company_name":{"description":"Commercial name of the company. Use the partner name if a commercial name is not available.","example":"XYZ Company","type":"string"},"contract_countries":{"description":"A list of all the country names for which contract has been signed.","example":["Netherlands","Australia"],"items":{"type":"string"},"type":"array"},"contract_signed":{"description":"Indicates whether the partner contract is signed. Returns 1 if signed, 0 if unsigned.","example":1,"format":"int32","type":"integer"},"country":{"description":"Country name of the partner company.","example":"Netherlands","type":"string"},"legal_contact_email":{"description":"Contact email of the partner. This is treated as the unique identifier for the partner.","example":"carol.xu@abc.com","type":"string"},"legal_contact_name":{"description":"Contact name of the person authorized to sign.","example":"Carol Xu","type":"string"},"legal_contact_phone_number":{"description":"Contact phone number of the partner.","example":"+31221122112","type":"string"},"legal_entity_id":{"description":"The legal entity ID of the new partner invited.","example":22567,"format":"int32","type":"integer"},"total_number_of_properties":{"description":"Total number of properties (at different addresses) listed under the legal entity.","example":2,"format":"int32","type":"integer"}},"required":["city","company_name","contract_countries","contract_signed","country","legal_contact_email","legal_contact_name","legal_contact_phone_number","legal_entity_id","total_number_of_properties"],"type":"object"}},"components/schemas/ReInviteObject":{"id":"components/schemas/ReInviteObject","kind":"json-schema","title":"ReInviteObject","data":{"properties":{"status":{"description":"Status message indicating whether the invitation email was resent successfully.","example":"Invitation sent to Partner.","type":"string"},"success":{"description":"A flag that indicates if the operation finished successfully.","example":1,"format":"int32","type":"integer"}},"required":["status","success"],"type":"object"}},"schema_368":{"kind":"json-schema","data":{"type":"string"},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"properties":{"city":{"description":"City name of the partner company.","type":"string"},"company_name":{"description":"Commercial name of the company. Use the partner name if a commercial name is not available.","type":"string"},"contract_countries":{"description":"List of country codes where the partner has properties.","items":{"type":"string"},"type":"array"},"country":{"description":"Country code of the partner company.","type":"string"},"is_test":{"description":"Indicates whether to create a test partner. Set to 1 for test partners, 0 for production partners.","enum":[0,1],"type":"integer"},"legal_contact_email":{"description":"Contact email of the partner. This is treated as the unique identifier for the partner.","type":"string"},"legal_contact_name":{"description":"Contact name of the person authorized to sign.","type":"string"},"legal_contact_phone_number":{"description":"Contact phone number of the partner.","type":"string"},"legal_name":{"description":"Legal name of the company used for official registration. Use the partner name if a legal name is not available.","type":"string"},"preferred_language":{"description":"The partner's preferred language code for communication.","type":"string"},"street":{"description":"Street name of the partner company.","type":"string"},"total_number_of_properties":{"description":"Total number of properties that the partner has.","format":"int32","type":"integer"},"website":{"description":"Website of the partner, if any.","type":"string"},"zipcode":{"description":"Zipcode of the partner company.","type":"string"}},"required":["company_name","legal_contact_email","legal_contact_name","preferred_language"],"type":"object"},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"properties":{"data":{"$ref":"#/components/schemas/InvitedPartnerObject"},"errors":{"$ref":"#/components/schemas/DiagnosisList"},"meta":{"properties":{"ruid":{"description":"Response Unique Identifier. Refer to this when talking to Booking.com Connectivity Support.","example":"XNlckRhdGEkYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXoxMjM0NTY3ODkwQUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVoxMjM0NTY3ODkw=","type":"string"}},"required":["ruid"],"type":"object"},"warnings":{"$ref":"#/components/schemas/DiagnosisList"}},"required":["data","meta"],"type":"object"},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"properties":{"data":{"$ref":"#/components/schemas/InvitedPartnerObject"},"errors":{"$ref":"#/components/schemas/DiagnosisList"},"meta":{"properties":{"ruid":{"description":"Response Unique Identifier. Refer to this when talking to Booking.com Connectivity Support.","example":"UmFuZG9tSVYkc2Rl...=","type":"string"}},"required":["ruid"],"type":"object"},"warnings":{"$ref":"#/components/schemas/DiagnosisList"}},"required":["meta"],"type":"object"},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"properties":{"errors":{"$ref":"#/components/schemas/DiagnosisList"},"meta":{"properties":{"ruid":{"description":"Response Unique Identifier. Refer to this when talking to Booking.com Connectivity Support.","example":"UmFuZG9tSVYkc2Rl...=","type":"string"}},"required":["ruid"],"type":"object"},"warnings":{"$ref":"#/components/schemas/DiagnosisList"}},"required":["errors","meta"],"type":"object"},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"properties":{"additional_countries":{"description":"List of country codes where partner has properties for which addendum should be signed.","items":{"type":"string"},"type":"array"},"is_test":{"description":"Flag to filter in/out test partner cards. Setting it to 1 will look for test partners only, 0 will look for non-test partners only.","enum":["0","1"],"type":"string"},"le_id":{"description":"Legal entity ID of the partner. This is treated as the unique identifier for the partner.","format":"int32","type":"integer"},"legal_contact_email":{"description":"Contract contact email ID of the partner. This is treated as the unique identifier for the partner.","type":"string"}},"required":["additional_countries"],"type":"object"},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"properties":{"data":{"$ref":"#/components/schemas/AddendumObject"},"errors":{"$ref":"#/components/schemas/DiagnosisList"},"meta":{"properties":{"ruid":{"description":"Response Unique Identifier. Refer to this when talking to Booking.com Connectivity Support.","example":"UmFuZG9tSVYkc2Rl...=","type":"string"}},"required":["ruid"],"type":"object"},"warnings":{"$ref":"#/components/schemas/DiagnosisList"}},"required":["data","meta"],"type":"object"},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"properties":{"is_test":{"description":"Flag to filter in/out test partner cards. Setting it to 1 will look for test partners only, 0 will look for non-test partners only.","enum":[0,1],"type":"integer"},"legal_contact_email":{"description":"Contract contact email id of the partner. This is treated as the unique identifier for the partner.","type":"string"}},"required":["legal_contact_email"],"type":"object"},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"properties":{"data":{"$ref":"#/components/schemas/ReInviteObject"},"errors":{"$ref":"#/components/schemas/DiagnosisList"},"meta":{"properties":{"ruid":{"description":"Response Unique Identifier. Refer to this when talking to Booking.com Connectivity Support.","example":"UmFuZG9tSVYkc2Rl...=","type":"string"}},"required":["ruid"],"type":"object"},"warnings":{"$ref":"#/components/schemas/DiagnosisList"}},"required":["data","meta"],"type":"object"},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"properties":{"is_test":{"description":"Flag to filter in/out test partner cards. Setting it to 1 will look for test partners only, 0 will look for non-test partners only.","enum":["0","1"],"type":"string"},"le_id":{"description":"Legal entity ID of the partner. This is treated as the unique identifier for the partner.","format":"int32","type":"integer"},"legal_contact_email":{"description":"Contract contact email ID of the partner. This is treated as the unique identifier for the partner.","type":"string"}},"type":"object"},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"properties":{"is_test":{"description":"Flag to filter in/out test partner cards. Setting it to 1 will look for test partners only, 0 will look for non-test partners only.","enum":[0,1],"type":"integer"},"legal_contact_email":{"description":"Contract contact email ID of the partner. This is treated as the unique identifier for the partner.","type":"string"}},"required":["legal_contact_email"],"type":"object"},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"properties":{"data":{"$ref":"#/components/schemas/PartnerDetailsObject"},"errors":{"$ref":"#/components/schemas/DiagnosisList"},"meta":{"properties":{"ruid":{"description":"Response Unique Identifier. Refer to this when talking to Booking.com Connectivity Support.","example":"UmFuZG9tSVYkc2Rl...=","type":"string"}},"required":["ruid"],"type":"object"},"warnings":{"$ref":"#/components/schemas/DiagnosisList"}},"required":["data","meta"],"type":"object"},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"properties":{"le_id":{"description":"Legal entity ID of the partner. This is treated as the unique identifier for the partner.","format":"int32","type":"integer"},"legal_contact_email":{"description":"Contract contact email id of the partner. This is treated as the unique identifier for the partner.","type":"string"}},"type":"object"},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"properties":{"data":{"properties":{"link_to_connect":{"description":"URL link for the partner to authorize the connectivity provider.","type":"string"}},"required":["link_to_connect"],"type":"object"},"errors":{"$ref":"#/components/schemas/DiagnosisList"},"meta":{"properties":{"ruid":{"description":"Response Unique Identifier. Refer to this when talking to Booking.com Connectivity Support.","example":"UmFuZG9tSVYkc2Rl...=","type":"string"}},"required":["ruid"],"type":"object"},"warnings":{"$ref":"#/components/schemas/DiagnosisList"}},"required":["data","meta"],"type":"object"},"id":"schema_382"}},"exampleStore":{"paths/~1partners~1invite/post/requestBody/content/application~1json/examples/create a test partner":{"value":{"city":"Amsterdam","company_name":"Parker hotels","country":"nl","legal_contact_email":"peter.park+test01@besthotelxyz.abc","contract_countries":["fr","nl"],"legal_contact_name":"Swan Park","legal_contact_phone_number":"+1234567890","legal_name":"Park hotels BV","preferred_language":"NL","street":"Streetstreet","total_number_of_properties":2,"zipcode":"1000AB","website":"https://www.besthotelxyz.abc","is_test":"1"},"key":"create a test partner","summary":"create a test partner","id":"paths/~1partners~1invite/post/requestBody/content/application~1json/examples/create a test partner"},"paths/~1partners~1invite/post/responses/200/content/application~1json/examples/success":{"value":{"meta":{"ruid":"XNlckRhdGEkYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXoxMjM0NTY3ODkwQUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVoxMjM0NTY3ODkw="},"errors":[],"data":{"legal_entity_id":22567},"warnings":[]},"key":"success","summary":"success","id":"paths/~1partners~1invite/post/responses/200/content/application~1json/examples/success"},"paths/~1partners~1invite/post/responses/201/content/application~1json/examples/success":{"value":{"meta":{"ruid":"VXNlckRhdGEkYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXoxMjM0NTY3ODkwQUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVoxMjM0NTY3ODkw"},"errors":[],"data":{"legal_entity_id":22567},"warnings":[]},"key":"success","summary":"success","id":"paths/~1partners~1invite/post/responses/201/content/application~1json/examples/success"},"paths/~1partners~1addendum/post/requestBody/content/application~1json/examples/add countries to partner":{"value":{"additional_countries":["be"],"le_id":14379109},"key":"add countries to partner","summary":"add countries to partner","id":"paths/~1partners~1addendum/post/requestBody/content/application~1json/examples/add countries to partner"},"paths/~1partners~1addendum/post/responses/200/content/application~1json/examples/Signed contract - add countries":{"value":{"data":{"success":1,"status":"Addendum invitation sent to Partner."},"errors":[],"warnings":[],"meta":{"ruid":"UlPrZG9tSVYkc2RlIyh9YeobhK72bvPcGuKpIGBV43CLA0/ew3f32vvfbcDMZPMJ2upJzzPiWPpwqgrzqgrYuylZFVYodyywjTysIR2C7iIMdzNV3jh=="}},"key":"Signed contract - add countries","summary":"Signed contract - add countries","description":"Response when adding countries to a partner with a signed contract. Addendum invitation is successfully sent to the partner.","id":"paths/~1partners~1addendum/post/responses/200/content/application~1json/examples/Signed contract - add countries"},"paths/~1partners~1addendum/post/responses/200/content/application~1json/examples/Unsigned contract - add countries":{"value":{"errors":[],"meta":{"ruid":"UmFuZG9tSVYkc2RlIyh9YaOnstqB7R/7ANiuo4cXIFQQBnpcnM52jQ+tsZVEd7pIlbl2ZlXAYk8UIk76XX9c0T1R+irM1u/lAu4cs5HIIfM="},"data":{"status":"New countries added to partner card and original contract. Addendum can not be sent as original contract not signed yet.","success":0},"warnings":[]},"key":"Unsigned contract - add countries","summary":"Unsigned contract - add countries","description":"Response when adding countries to a partner whose original contract is not yet signed. Countries are added but addendum cannot be sent.","id":"paths/~1partners~1addendum/post/responses/200/content/application~1json/examples/Unsigned contract - add countries"},"paths/~1partners~1resend-invite/post/requestBody/content/application~1json/examples/resend invitation":{"value":{"legal_contact_email":"peter.park+test01@besthotelxyz.abc"},"key":"resend invitation","summary":"resend invitation","id":"paths/~1partners~1resend-invite/post/requestBody/content/application~1json/examples/resend invitation"},"paths/~1partners~1resend-invite/post/responses/200/content/application~1json/examples/success":{"value":{"meta":{"ruid":"UmFuZG9tSVYkc2RlIyh9Ya+pg/21ggUOrSQsocNZo8+onmuF/0Np5bNl9bXkIHOzcL5xe4+2Q5m5Yz4XU6LD/TrgwjmmpchX1cKrgLwhK4o="},"data":{"status":"Invitation sent to Partner.","success":1},"warnings":[],"errors":[]},"key":"success","summary":"success","id":"paths/~1partners~1resend-invite/post/responses/200/content/application~1json/examples/success"},"paths/~1partners~1resend-addendum/post/requestBody/content/application~1json/examples/resend addendum":{"value":{"le_id":14379109},"key":"resend addendum","summary":"resend addendum","id":"paths/~1partners~1resend-addendum/post/requestBody/content/application~1json/examples/resend addendum"},"paths/~1partners~1resend-addendum/post/responses/200/content/application~1json/examples/success":{"value":{"errors":[],"data":{"success":1,"status":"Addendum invitation resent to Partner."},"warnings":[],"meta":{"ruid":"UmFuZG9tSVYkc2RlIyh9YUNOyFG1G7yZ4N4g32GjUq4m7gLy4mLHvgfKCKKcaShQJ1ARh2IeVOWB/7DRTmDzp3Eh6SJyAq2mtqfDc16BxoY="}},"key":"success","summary":"success","id":"paths/~1partners~1resend-addendum/post/responses/200/content/application~1json/examples/success"},"paths/~1partners~1legal-details/post/requestBody/content/application~1json/examples/check legal details":{"value":{"legal_contact_email":"peter.park+test01@besthotelxyz.abc"},"key":"check legal details","summary":"check legal details","id":"paths/~1partners~1legal-details/post/requestBody/content/application~1json/examples/check legal details"},"paths/~1partners~1legal-details/post/responses/200/content/application~1json/examples/success":{"value":{"errors":[],"meta":{"ruid":"UmFuZG9tSVYkc2RlIyh9YRll+GVIGb80fIDE6KNg2nbBKSUQRt7HhDjIguTKWN9Pg8gPklY1ZTR8dD1jnGM3rO5t+gxp8LWUtuQkhhMwEqI="},"warnings":[],"data":{"legal_contact_phone_number":"+1234567890","city":"Amsterdam","legal_entity_id":14379109,"total_number_of_properties":2,"legal_contact_name":"Swan Park","contract_signed":0,"country":"Netherlands","company_name":"Parker hotels","legal_contact_email":"peter.park+test01@besthotelxyz.abc","contract_countries":[]}},"key":"success","summary":"success","id":"paths/~1partners~1legal-details/post/responses/200/content/application~1json/examples/success"},"paths/~1partners~1legal-details~1legal-entity~1{id}/get/responses/200/content/application~1json/examples/success":{"value":{"meta":{"ruid":"UmFuZG9tSVYkc2RlIyh9YXJtZEFqth9mfKWAQSzFM+NoL9XfH+8fk9tAnQIdYDtio5B/cZzBRDAIjKvHJ7U6HDa9DoKs6xKWe91kJYn9IYI="},"errors":[],"warnings":[],"data":{"legal_entity_id":14379109,"legal_contact_name":"Swan Park","company_name":"Parker hotels","total_number_of_properties":2,"country":"Netherlands","legal_contact_email":"peter.park+test01@besthotelxyz.abc","contract_signed":0,"legal_contact_phone_number":"+1234567890","city":"Amsterdam","contract_countries":[]}},"key":"success","summary":"success","id":"paths/~1partners~1legal-details~1legal-entity~1{id}/get/responses/200/content/application~1json/examples/success"},"paths/~1partners~1request_access/post/requestBody/content/application~1json/examples/request access":{"value":{"le_id":14379109},"key":"request access","summary":"request access","id":"paths/~1partners~1request_access/post/requestBody/content/application~1json/examples/request access"},"paths/~1partners~1request_access/post/responses/200/content/application~1json/examples/success":{"value":{"data":{"link_to_connect":"https://admin.booking.com/hotel/hoteladmin/extranet_ng/manage/channel-manager/authorize_connectivity_provider.html?uuid=CFCE5640-Q21A-00Z0-892F-8FF19DC8E916"},"errors":[],"warnings":[],"meta":{"ruid":"UmFuZG9tSVYkc2RlIyh9YfU1y5UhuOwySx8U7ODUMv1XFnS2gZqGrD7Qnnx7KwM3nrQ86Wa25ThCRDZD+9g/b3Alw/i7IPQV9GXD3lES74I="}},"key":"success","summary":"success","id":"paths/~1partners~1request_access/post/responses/200/content/application~1json/examples/success"},"paths/~1partners~1request_access/post/responses/400/content/application~1json/examples/partner already connected":{"value":{"warnings":[],"errors":[{"details":null,"message":"Partner is already connected to provider","code":"INVALID_ARGUMENT"}],"meta":{"ruid":"UmFuZG9tSVYkc2RlIyh9YRXWxUR5Litn5pPevveOX8oBhmf6nZoVn6uKALFMZP1jBI0i8W/GxVS8u056NVS10CWYux3L2ldO2PX3dkhcDJM="}},"key":"partner already connected","summary":"partner already connected","id":"paths/~1partners~1request_access/post/responses/400/content/application~1json/examples/partner already connected"}},"securitySchemeStore":{},"servers":[{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","isMockServer":true,"description":"Mock (schema only)"},{"url":"https://supply-xml.booking.com/contracts-api","description":"Test using live endpoint"}]},"options":{"feedback":{"hide":true,"settings":{"label":""}},"corsProxyUrl":"https://cors.redoc.ly","pagination":"section","hideSidebar":true,"mockServer":{"url":"/_mock/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","position":"first","description":"Mock (schema only)","off":false},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion.json?download"},{"url":"/_bundle/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Contracting API","description":"\nUse the Contracting API to invite a new partner on Booking.com, check whether a partner has signed the contract, resend invitation mail and retrieve the legal entity of the partner.\n## Authentication\nThe Contracting API supports token-based authentication. Each request must have an `Authorization` header containing a JWT token. Manage your machine accounts in the [Connectivity Portal](https://developers.booking.com). See also the [Authentication page](/connectivity/docs/authentication) of the documentation.\n## Message formats\nThe Contracting API accepts and returns JSON.\n## Documentation\nRead the [Contracting API documentation](/connectivity/docs/contracting-api/understanding-the-contracting-api) for more details about working with this API.\n"}},"baseSlug":"/connectivity/docs/openapispecs/contracting-api/contracting-api-specificaion","routesMapping":{}}