{"items":[{"type":"link","label":"Closelink Webhooks API","link":"/webhooks/webhooks","routeSlug":"/webhooks/webhooks","content":{"contentType":"overview","meta":{"name":"Closelink Webhooks API"},"children":[{"nodeType":"container","panels":[{"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/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Closelink Webhooks API (2.36)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Closelink webhook reference"}],"sectionId":"/webhooks/webhooks"}],"sectionId":"/webhooks/webhooks"}]}]}},{"type":"separator","label":"","content":null},{"type":"group","label":"Webhook Management","link":"/webhooks/webhooks/webhook-management","routeSlug":"/webhooks/webhooks/webhook-management","items":[{"label":"Update webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhook-management/updatewebhook","routeSlug":"/webhooks/webhooks/webhook-management/updatewebhook","metadata":{"seo":{"title":"Update webhook","description":"Update an existing webhook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhook","name":"Update webhook","isWebhook":false,"pointer":"/paths/~1v1~1webhooks~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing webhook"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_36","description":"Webhook ID","required":true,"example":"572206b5e4b0d7441f638363"}],"pointer":"/paths/~1v1~1webhooks~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookRequestMessage"}},"schemaId":"components/schemas/WebhookRequestMessage","pointer":"/paths/~1v1~1webhooks~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/webhooks/{id}","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"572206b5e4b0d7441f638363","schemaId":"schema_36","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookRequestMessage"}},"responseCodes":["200","400","404"],"pointer":"/v1/webhooks/{id}","href":"webhook-management/updatewebhook","openApiOperationId":"updateWebhook","summary":"Update webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"schemaId":"components/schemas/WebhookRequestMessage","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookRequestMessage"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponseMessage"}},"schemaId":"components/schemas/WebhookResponseMessage"},{"code":"400","description":"Bad request if validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponseMessage"}},"schemaId":"components/schemas/ValidationErrorResponseMessage"},{"code":"404","description":"Not found if webhook does not exist"}],"pointer":"/paths/~1v1~1webhooks~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookResponseMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponseMessage"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponseMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponseMessage"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-management/updatewebhook"}],"panels":[]}]},"httpPath":"/v1/webhooks/{id}"},{"label":"Delete webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhook-management/deletewebhook","routeSlug":"/webhooks/webhooks/webhook-management/deletewebhook","metadata":{"seo":{"title":"Delete webhook","description":"Delete an existing webhook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhook","name":"Delete webhook","isWebhook":false,"pointer":"/paths/~1v1~1webhooks~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an existing webhook"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_36","description":"Webhook ID","required":true,"example":"572206b5e4b0d7441f638363"}],"pointer":"/paths/~1v1~1webhooks~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/webhooks/{id}","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"572206b5e4b0d7441f638363","schemaId":"schema_36","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/webhooks/{id}","href":"webhook-management/deletewebhook","openApiOperationId":"deleteWebhook","summary":"Delete webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponseMessage"}},"schemaId":"components/schemas/ValidationErrorResponseMessage"},{"code":"404","description":"Not found if webhook does not exist"}],"pointer":"/paths/~1v1~1webhooks~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponseMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponseMessage"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-management/deletewebhook"}],"panels":[]}]},"httpPath":"/v1/webhooks/{id}"},{"label":"Find webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhook-management/findwebhooks","routeSlug":"/webhooks/webhooks/webhook-management/findwebhooks","metadata":{"seo":{"title":"Find webhooks","description":"Query for multiple webhooks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"findWebhooks","name":"Find webhooks","isWebhook":false,"pointer":"/paths/~1v1~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Find webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Query for multiple webhooks"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"groupId","in":"query","schemaId":"schema_36","description":"ID of the company group"}],"pointer":"/paths/~1v1~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/webhooks","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[],"query":[{"name":"groupId","in":"query","required":false,"schemaId":"schema_36","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/webhooks","href":"webhook-management/findwebhooks","openApiOperationId":"findWebhooks","summary":"Find webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhooksResponseMessage"}},"schemaId":"components/schemas/WebhooksResponseMessage"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponseMessage"}},"schemaId":"components/schemas/ValidationErrorResponseMessage"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhooksResponseMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhooksResponseMessage"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponseMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponseMessage"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-management/findwebhooks"}],"panels":[]}]},"httpPath":"/v1/webhooks"},{"label":"Create webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhook-management/createwebhook","routeSlug":"/webhooks/webhooks/webhook-management/createwebhook","metadata":{"seo":{"title":"Create webhook","description":"createWebhook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhook","name":"Create webhook","isWebhook":false,"pointer":"/paths/~1v1~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"createWebhook"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookRequestMessage"}},"schemaId":"components/schemas/WebhookRequestMessage","pointer":"/paths/~1v1~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhooks","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookRequestMessage"}},"responseCodes":["200","400","404"],"pointer":"/v1/webhooks","href":"webhook-management/createwebhook","openApiOperationId":"createWebhook","summary":"Create webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"schemaId":"components/schemas/WebhookRequestMessage","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookRequestMessage"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponseMessage"}},"schemaId":"components/schemas/WebhookResponseMessage"},{"code":"400","description":"Bad request if validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponseMessage"}},"schemaId":"components/schemas/ValidationErrorResponseMessage"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookResponseMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponseMessage"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponseMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponseMessage"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-management/createwebhook"}],"panels":[]}]},"httpPath":"/v1/webhooks"}],"content":{"contentType":"group","meta":{"name":"Webhook Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook Management","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhooks/{id}","summary":"Update webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhook-management/updatewebhook","deprecated":false},{"title":"/v1/webhooks/{id}","summary":"Delete webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhook-management/deletewebhook","deprecated":false},{"title":"/v1/webhooks","summary":"Find webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook-management/findwebhooks","deprecated":false},{"title":"/v1/webhooks","summary":"Create webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-management/createwebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Draft Events","link":"/webhooks/webhooks/draft-events","routeSlug":"/webhooks/webhooks/draft-events","items":[{"label":"Draft Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/draft-events/paths/draftcreated/post","routeSlug":"/webhooks/webhooks/draft-events/paths/draftcreated/post","metadata":{"seo":{"title":"Draft Created","description":"Triggered when a draft enquiry is created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Draft Created","isWebhook":true,"pointer":"/paths/draftCreated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Draft Created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when a draft enquiry is created"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Closelink-Delivery","in":"header","schemaId":"schema_37","description":"Unique id of the exact webhook execution","example":"507f1f77bcf86cd799439011"},{"name":"Closelink-Event","in":"header","schemaId":"schema_37","description":"The resource type of the event","example":"OFFER"},{"name":"Closelink-Signature","in":"header","schemaId":"schema_37","description":"HMAC signature of the payload using the webhook secret","example":"x48656C6C6F"}],"pointer":"/paths/draftCreated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"schemaId":"components/schemas/DraftEnquiryWebhookPayload","pointer":"/paths/draftCreated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"draftCreated","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Closelink-Delivery","in":"header","required":false,"example":"507f1f77bcf86cd799439011","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Event","in":"header","required":false,"example":"OFFER","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Signature","in":"header","required":false,"example":"x48656C6C6F","schemaId":"schema_37","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"responseCodes":["204"],"pointer":"draftCreated","href":"draft-events/paths/draftcreated/post","summary":"Draft Created"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"schemaId":"components/schemas/DraftEnquiryWebhookPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content"}],"pointer":"/paths/draftCreated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/draft-events/paths/draftcreated/post"}],"panels":[]}]},"httpPath":"draftCreated"},{"label":"Draft Deleted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/draft-events/paths/draftdeleted/post","routeSlug":"/webhooks/webhooks/draft-events/paths/draftdeleted/post","metadata":{"seo":{"title":"Draft Deleted","description":"Triggered when a draft enquiry is deleted"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Draft Deleted","isWebhook":true,"pointer":"/paths/draftDeleted/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Draft Deleted","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when a draft enquiry is deleted"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Closelink-Delivery","in":"header","schemaId":"schema_37","description":"Unique id of the exact webhook execution","example":"507f1f77bcf86cd799439011"},{"name":"Closelink-Event","in":"header","schemaId":"schema_37","description":"The resource type of the event","example":"OFFER"},{"name":"Closelink-Signature","in":"header","schemaId":"schema_37","description":"HMAC signature of the payload using the webhook secret","example":"x48656C6C6F"}],"pointer":"/paths/draftDeleted/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"schemaId":"components/schemas/DraftEnquiryWebhookPayload","pointer":"/paths/draftDeleted/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"draftDeleted","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Closelink-Delivery","in":"header","required":false,"example":"507f1f77bcf86cd799439011","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Event","in":"header","required":false,"example":"OFFER","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Signature","in":"header","required":false,"example":"x48656C6C6F","schemaId":"schema_37","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"responseCodes":["204"],"pointer":"draftDeleted","href":"draft-events/paths/draftdeleted/post","summary":"Draft Deleted"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"schemaId":"components/schemas/DraftEnquiryWebhookPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content"}],"pointer":"/paths/draftDeleted/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/draft-events/paths/draftdeleted/post"}],"panels":[]}]},"httpPath":"draftDeleted"},{"label":"Draft Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/draft-events/paths/draftupdated/post","routeSlug":"/webhooks/webhooks/draft-events/paths/draftupdated/post","metadata":{"seo":{"title":"Draft Updated","description":"Triggered when a draft enquiry is updated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Draft Updated","isWebhook":true,"pointer":"/paths/draftUpdated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Draft Updated","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when a draft enquiry is updated"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Closelink-Delivery","in":"header","schemaId":"schema_37","description":"Unique id of the exact webhook execution","example":"507f1f77bcf86cd799439011"},{"name":"Closelink-Event","in":"header","schemaId":"schema_37","description":"The resource type of the event","example":"OFFER"},{"name":"Closelink-Signature","in":"header","schemaId":"schema_37","description":"HMAC signature of the payload using the webhook secret","example":"x48656C6C6F"}],"pointer":"/paths/draftUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"schemaId":"components/schemas/DraftEnquiryWebhookPayload","pointer":"/paths/draftUpdated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"draftUpdated","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Closelink-Delivery","in":"header","required":false,"example":"507f1f77bcf86cd799439011","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Event","in":"header","required":false,"example":"OFFER","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Signature","in":"header","required":false,"example":"x48656C6C6F","schemaId":"schema_37","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"responseCodes":["204"],"pointer":"draftUpdated","href":"draft-events/paths/draftupdated/post","summary":"Draft Updated"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"schemaId":"components/schemas/DraftEnquiryWebhookPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content"}],"pointer":"/paths/draftUpdated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/draft-events/paths/draftupdated/post"}],"panels":[]}]},"httpPath":"draftUpdated"}],"content":{"contentType":"group","meta":{"name":"Draft Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Draft Events","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"draftCreated","summary":"Draft Created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/draft-events/paths/draftcreated/post","deprecated":false},{"title":"draftDeleted","summary":"Draft Deleted","prefix":{"name":"post","color":"post"},"badges":[],"link":"/draft-events/paths/draftdeleted/post","deprecated":false},{"title":"draftUpdated","summary":"Draft Updated","prefix":{"name":"post","color":"post"},"badges":[],"link":"/draft-events/paths/draftupdated/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Enquiry Events","link":"/webhooks/webhooks/enquiry-events","routeSlug":"/webhooks/webhooks/enquiry-events","items":[{"label":"Enquiry Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/enquiry-events/paths/enquirycreated/post","routeSlug":"/webhooks/webhooks/enquiry-events/paths/enquirycreated/post","metadata":{"seo":{"title":"Enquiry Created","description":"Triggered when an enquiry is created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Enquiry Created","isWebhook":true,"pointer":"/paths/enquiryCreated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enquiry Created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when an enquiry is created"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Closelink-Delivery","in":"header","schemaId":"schema_37","description":"Unique id of the exact webhook execution","example":"507f1f77bcf86cd799439011"},{"name":"Closelink-Event","in":"header","schemaId":"schema_37","description":"The resource type of the event","example":"OFFER"},{"name":"Closelink-Signature","in":"header","schemaId":"schema_37","description":"HMAC signature of the payload using the webhook secret","example":"x48656C6C6F"}],"pointer":"/paths/enquiryCreated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"schemaId":"components/schemas/DraftEnquiryWebhookPayload","pointer":"/paths/enquiryCreated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"enquiryCreated","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Closelink-Delivery","in":"header","required":false,"example":"507f1f77bcf86cd799439011","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Event","in":"header","required":false,"example":"OFFER","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Signature","in":"header","required":false,"example":"x48656C6C6F","schemaId":"schema_37","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"responseCodes":["204"],"pointer":"enquiryCreated","href":"enquiry-events/paths/enquirycreated/post","summary":"Enquiry Created"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"schemaId":"components/schemas/DraftEnquiryWebhookPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content"}],"pointer":"/paths/enquiryCreated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enquiry-events/paths/enquirycreated/post"}],"panels":[]}]},"httpPath":"enquiryCreated"},{"label":"Enquiry Draft Submitted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/enquiry-events/paths/enquirydraftsubmitted/post","routeSlug":"/webhooks/webhooks/enquiry-events/paths/enquirydraftsubmitted/post","metadata":{"seo":{"title":"Enquiry Draft Submitted","description":"Triggered when an enquiry draft is submitted"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Enquiry Draft Submitted","isWebhook":true,"pointer":"/paths/enquiryDraftSubmitted/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enquiry Draft Submitted","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when an enquiry draft is submitted"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Closelink-Delivery","in":"header","schemaId":"schema_37","description":"Unique id of the exact webhook execution","example":"507f1f77bcf86cd799439011"},{"name":"Closelink-Event","in":"header","schemaId":"schema_37","description":"The resource type of the event","example":"OFFER"},{"name":"Closelink-Signature","in":"header","schemaId":"schema_37","description":"HMAC signature of the payload using the webhook secret","example":"x48656C6C6F"}],"pointer":"/paths/enquiryDraftSubmitted/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"schemaId":"components/schemas/DraftEnquiryWebhookPayload","pointer":"/paths/enquiryDraftSubmitted/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"enquiryDraftSubmitted","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Closelink-Delivery","in":"header","required":false,"example":"507f1f77bcf86cd799439011","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Event","in":"header","required":false,"example":"OFFER","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Signature","in":"header","required":false,"example":"x48656C6C6F","schemaId":"schema_37","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"responseCodes":["204"],"pointer":"enquiryDraftSubmitted","href":"enquiry-events/paths/enquirydraftsubmitted/post","summary":"Enquiry Draft Submitted"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"schemaId":"components/schemas/DraftEnquiryWebhookPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content"}],"pointer":"/paths/enquiryDraftSubmitted/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enquiry-events/paths/enquirydraftsubmitted/post"}],"panels":[]}]},"httpPath":"enquiryDraftSubmitted"},{"label":"Enquiry Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/enquiry-events/paths/enquiryupdated/post","routeSlug":"/webhooks/webhooks/enquiry-events/paths/enquiryupdated/post","metadata":{"seo":{"title":"Enquiry Updated","description":"Triggered when an enquiry is updated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Enquiry Updated","isWebhook":true,"pointer":"/paths/enquiryUpdated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enquiry Updated","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when an enquiry is updated"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Closelink-Delivery","in":"header","schemaId":"schema_37","description":"Unique id of the exact webhook execution","example":"507f1f77bcf86cd799439011"},{"name":"Closelink-Event","in":"header","schemaId":"schema_37","description":"The resource type of the event","example":"OFFER"},{"name":"Closelink-Signature","in":"header","schemaId":"schema_37","description":"HMAC signature of the payload using the webhook secret","example":"x48656C6C6F"}],"pointer":"/paths/enquiryUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"schemaId":"components/schemas/DraftEnquiryWebhookPayload","pointer":"/paths/enquiryUpdated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"enquiryUpdated","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Closelink-Delivery","in":"header","required":false,"example":"507f1f77bcf86cd799439011","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Event","in":"header","required":false,"example":"OFFER","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Signature","in":"header","required":false,"example":"x48656C6C6F","schemaId":"schema_37","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"responseCodes":["204"],"pointer":"enquiryUpdated","href":"enquiry-events/paths/enquiryupdated/post","summary":"Enquiry Updated"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"schemaId":"components/schemas/DraftEnquiryWebhookPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DraftEnquiryWebhookPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content"}],"pointer":"/paths/enquiryUpdated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enquiry-events/paths/enquiryupdated/post"}],"panels":[]}]},"httpPath":"enquiryUpdated"}],"content":{"contentType":"group","meta":{"name":"Enquiry Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enquiry Events","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"enquiryCreated","summary":"Enquiry Created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enquiry-events/paths/enquirycreated/post","deprecated":false},{"title":"enquiryDraftSubmitted","summary":"Enquiry Draft Submitted","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enquiry-events/paths/enquirydraftsubmitted/post","deprecated":false},{"title":"enquiryUpdated","summary":"Enquiry Updated","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enquiry-events/paths/enquiryupdated/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Offer Events","link":"/webhooks/webhooks/offer-events","routeSlug":"/webhooks/webhooks/offer-events","items":[{"label":"Offer Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/offer-events/paths/offercreated/post","routeSlug":"/webhooks/webhooks/offer-events/paths/offercreated/post","metadata":{"seo":{"title":"Offer Created","description":"Triggered when an offer is created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Offer Created","isWebhook":true,"pointer":"/paths/offerCreated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Offer Created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when an offer is created"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Closelink-Delivery","in":"header","schemaId":"schema_37","description":"Unique id of the exact webhook execution","example":"507f1f77bcf86cd799439011"},{"name":"Closelink-Event","in":"header","schemaId":"schema_37","description":"The resource type of the event","example":"OFFER"},{"name":"Closelink-Signature","in":"header","schemaId":"schema_37","description":"HMAC signature of the payload using the webhook secret","example":"x48656C6C6F"}],"pointer":"/paths/offerCreated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferWebhookPayload"}},"schemaId":"components/schemas/OfferWebhookPayload","pointer":"/paths/offerCreated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"offerCreated","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Closelink-Delivery","in":"header","required":false,"example":"507f1f77bcf86cd799439011","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Event","in":"header","required":false,"example":"OFFER","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Signature","in":"header","required":false,"example":"x48656C6C6F","schemaId":"schema_37","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferWebhookPayload"}},"responseCodes":["204"],"pointer":"offerCreated","href":"offer-events/paths/offercreated/post","summary":"Offer Created"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"schemaId":"components/schemas/OfferWebhookPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferWebhookPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content"}],"pointer":"/paths/offerCreated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/offer-events/paths/offercreated/post"}],"panels":[]}]},"httpPath":"offerCreated"},{"label":"Offer Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/offer-events/paths/offerupdated/post","routeSlug":"/webhooks/webhooks/offer-events/paths/offerupdated/post","metadata":{"seo":{"title":"Offer Updated","description":"Triggered when an offer is updated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Offer Updated","isWebhook":true,"pointer":"/paths/offerUpdated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Offer Updated","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when an offer is updated"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Closelink-Delivery","in":"header","schemaId":"schema_37","description":"Unique id of the exact webhook execution","example":"507f1f77bcf86cd799439011"},{"name":"Closelink-Event","in":"header","schemaId":"schema_37","description":"The resource type of the event","example":"OFFER"},{"name":"Closelink-Signature","in":"header","schemaId":"schema_37","description":"HMAC signature of the payload using the webhook secret","example":"x48656C6C6F"}],"pointer":"/paths/offerUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferWebhookPayload"}},"schemaId":"components/schemas/OfferWebhookPayload","pointer":"/paths/offerUpdated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"offerUpdated","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Closelink-Delivery","in":"header","required":false,"example":"507f1f77bcf86cd799439011","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Event","in":"header","required":false,"example":"OFFER","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Signature","in":"header","required":false,"example":"x48656C6C6F","schemaId":"schema_37","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferWebhookPayload"}},"responseCodes":["204"],"pointer":"offerUpdated","href":"offer-events/paths/offerupdated/post","summary":"Offer Updated"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"schemaId":"components/schemas/OfferWebhookPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferWebhookPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content"}],"pointer":"/paths/offerUpdated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/offer-events/paths/offerupdated/post"}],"panels":[]}]},"httpPath":"offerUpdated"}],"content":{"contentType":"group","meta":{"name":"Offer Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Offer Events","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"offerCreated","summary":"Offer Created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/offer-events/paths/offercreated/post","deprecated":false},{"title":"offerUpdated","summary":"Offer Updated","prefix":{"name":"post","color":"post"},"badges":[],"link":"/offer-events/paths/offerupdated/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Approval Request Events","link":"/webhooks/webhooks/approval-request-events","routeSlug":"/webhooks/webhooks/approval-request-events","items":[{"label":"Approval Request Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/approval-request-events/paths/approvalrequestcreated/post","routeSlug":"/webhooks/webhooks/approval-request-events/paths/approvalrequestcreated/post","metadata":{"seo":{"title":"Approval Request Created","description":"Triggered when an approval request is created"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Approval Request Created","isWebhook":true,"pointer":"/paths/approvalRequestCreated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approval Request Created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when an approval request is created"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Closelink-Delivery","in":"header","schemaId":"schema_37","description":"Unique id of the exact webhook execution","example":"507f1f77bcf86cd799439011"},{"name":"Closelink-Event","in":"header","schemaId":"schema_37","description":"The resource type of the event","example":"OFFER"},{"name":"Closelink-Signature","in":"header","schemaId":"schema_37","description":"HMAC signature of the payload using the webhook secret","example":"x48656C6C6F"}],"pointer":"/paths/approvalRequestCreated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApprovalRequestWebhookPayload"}},"schemaId":"components/schemas/ApprovalRequestWebhookPayload","pointer":"/paths/approvalRequestCreated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"approvalRequestCreated","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Closelink-Delivery","in":"header","required":false,"example":"507f1f77bcf86cd799439011","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Event","in":"header","required":false,"example":"OFFER","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Signature","in":"header","required":false,"example":"x48656C6C6F","schemaId":"schema_37","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApprovalRequestWebhookPayload"}},"responseCodes":["204"],"pointer":"approvalRequestCreated","href":"approval-request-events/paths/approvalrequestcreated/post","summary":"Approval Request Created"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"schemaId":"components/schemas/ApprovalRequestWebhookPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApprovalRequestWebhookPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content"}],"pointer":"/paths/approvalRequestCreated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/approval-request-events/paths/approvalrequestcreated/post"}],"panels":[]}]},"httpPath":"approvalRequestCreated"},{"label":"Approval Request Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/approval-request-events/paths/approvalrequestupdated/post","routeSlug":"/webhooks/webhooks/approval-request-events/paths/approvalrequestupdated/post","metadata":{"seo":{"title":"Approval Request Updated","description":"Triggered when an approval request is updated"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Approval Request Updated","isWebhook":true,"pointer":"/paths/approvalRequestUpdated/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approval Request Updated","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when an approval request is updated"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apikey","scopes":[],"type":"apiKey","in":"header","paramName":"ApiKey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Closelink-Delivery","in":"header","schemaId":"schema_37","description":"Unique id of the exact webhook execution","example":"507f1f77bcf86cd799439011"},{"name":"Closelink-Event","in":"header","schemaId":"schema_37","description":"The resource type of the event","example":"OFFER"},{"name":"Closelink-Signature","in":"header","schemaId":"schema_37","description":"HMAC signature of the payload using the webhook secret","example":"x48656C6C6F"}],"pointer":"/paths/approvalRequestUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApprovalRequestWebhookPayload"}},"schemaId":"components/schemas/ApprovalRequestWebhookPayload","pointer":"/paths/approvalRequestUpdated/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"approvalRequestUpdated","servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Closelink-Delivery","in":"header","required":false,"example":"507f1f77bcf86cd799439011","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Event","in":"header","required":false,"example":"OFFER","schemaId":"schema_37","style":"simple","explode":false},{"name":"Closelink-Signature","in":"header","required":false,"example":"x48656C6C6F","schemaId":"schema_37","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"apikey","type":"apiKey","name":"ApiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApprovalRequestWebhookPayload"}},"responseCodes":["204"],"pointer":"approvalRequestUpdated","href":"approval-request-events/paths/approvalrequestupdated/post","summary":"Approval Request Updated"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/webhooks/webhooks","description":"Mock server","isMockServer":true},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}],"schemaId":"components/schemas/ApprovalRequestWebhookPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApprovalRequestWebhookPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content"}],"pointer":"/paths/approvalRequestUpdated/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/approval-request-events/paths/approvalrequestupdated/post"}],"panels":[]}]},"httpPath":"approvalRequestUpdated"}],"content":{"contentType":"group","meta":{"name":"Approval Request Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approval Request Events","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"approvalRequestCreated","summary":"Approval Request Created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/approval-request-events/paths/approvalrequestcreated/post","deprecated":false},{"title":"approvalRequestUpdated","summary":"Approval Request Updated","prefix":{"name":"post","color":"post"},"badges":[],"link":"/approval-request-events/paths/approvalrequestupdated/post","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ItemChangesMessage":{"id":"components/schemas/ItemChangesMessage","kind":"json-schema","title":"ItemChangesMessage","data":{"type":"object","description":"Model for item changes","properties":{"productIdChanged":{"type":"boolean","description":"Whether the product ID was changed","example":true},"unitSizeChanged":{"type":"boolean","description":"Whether the unit size was changed","example":false},"unitsChanged":{"type":"boolean","description":"Whether the number of units was changed","example":true},"priceChanged":{"type":"boolean","description":"Whether the price was changed","example":false},"packTypeChanged":{"type":"boolean","description":"Whether the pack type was changed","example":true},"unitChanged":{"type":"boolean","description":"Whether the unit was changed","example":false}},"required":["packTypeChanged","priceChanged","productIdChanged","unitChanged","unitSizeChanged","unitsChanged"]}},"components/schemas/ProductSourceValueMessage":{"id":"components/schemas/ProductSourceValueMessage","kind":"json-schema","title":"ProductSourceValueMessage","data":{"type":"object","description":"Original source product value","properties":{"name":{"type":"string","description":"The product name from the source system","example":"Mobilgard M440"}},"required":["name"]}},"components/schemas/ItemSourceValuesMessage":{"id":"components/schemas/ItemSourceValuesMessage","kind":"json-schema","title":"ItemSourceValuesMessage","data":{"type":"object","description":"Original source values for an imported item","properties":{"product":{"$ref":"#/components/schemas/ProductSourceValueMessage","description":"Original source product value"}},"required":["product"]}},"components/schemas/OrderItemMessage":{"id":"components/schemas/OrderItemMessage","kind":"json-schema","title":"OrderItemMessage","data":{"type":"object","description":"Item model","properties":{"index":{"type":["integer","null"],"format":"int32","description":"The index of the item","example":1},"productId":{"type":["string","null"],"description":"The product ID of the item","example":"572206b5e4b0d7441f638364"},"packType":{"type":["string","null"],"description":"The pack type of the item","example":"DRUMS"},"unitSize":{"type":["number","null"],"description":"The unit size of the item","example":208},"units":{"type":["number","null"],"description":"The number of units of the item","example":10},"unit":{"type":["string","null"],"description":"The unit of the item","example":"L"},"volume":{"type":["number","null"],"description":"The volume of the item","example":15},"added":{"type":["boolean","null"],"description":"Whether the item was added","example":true},"deleted":{"type":["boolean","null"],"description":"Whether the item was deleted","example":false},"changes":{"oneOf":[{"$ref":"#/components/schemas/ItemChangesMessage"},{"type":"null"}]},"sourceValues":{"oneOf":[{"$ref":"#/components/schemas/ItemSourceValuesMessage"},{"type":"null"}]}}}},"components/schemas/MoneyMessage":{"id":"components/schemas/MoneyMessage","kind":"json-schema","title":"MoneyMessage","data":{"type":"object","description":"Money model","properties":{"value":{"type":["number","null"],"description":"The value of the money","example":100},"currency":{"type":["string","null"],"description":"The currency of the money","example":"USD"}}}},"components/schemas/SamplekitChanges":{"id":"components/schemas/SamplekitChanges","kind":"json-schema","title":"SamplekitChanges","data":{"type":"object","description":"Model for sample kit changes","properties":{"nameChanged":{"type":"boolean","description":"Whether the name was changed","example":true},"valueChanged":{"type":"boolean","description":"Whether the value was changed","example":false},"quantityChanged":{"type":"boolean","description":"Whether the quantity was changed","example":true}},"required":["nameChanged","quantityChanged","valueChanged"]}},"components/schemas/SamplekitMessage":{"id":"components/schemas/SamplekitMessage","kind":"json-schema","title":"SamplekitMessage","data":{"type":"object","description":"Sample kit model","properties":{"name":{"type":["string","null"],"description":"The name of the sample kit","example":"Sample Kit A"},"quantity":{"type":["integer","null"],"format":"int64","description":"The quantity of the sample kit","example":10},"value":{"oneOf":[{"$ref":"#/components/schemas/MoneyMessage"},{"type":"null"}]},"changes":{"oneOf":[{"$ref":"#/components/schemas/SamplekitChanges"},{"type":"null"}]},"added":{"type":["boolean","null"],"description":"Whether the sample kit was added","example":true},"deleted":{"type":["boolean","null"],"description":"Whether the sample kit was deleted","example":false}}}},"components/schemas/EnquiryMessage":{"id":"components/schemas/EnquiryMessage","kind":"json-schema","title":"EnquiryMessage","data":{"type":"object","description":"Enquiry model","properties":{"id":{"type":["string","null"],"description":"The ID of the enquiry","example":"5fc4f3b053e79838873f72e9"},"dateCreated":{"type":["string","null"],"description":"The date the enquiry was created","example":"2023-10-01T12:00:00Z"},"dateUpdated":{"type":["string","null"],"description":"The date the enquiry was last updated","example":"2023-10-02T12:00:00Z"},"version":{"type":["integer","null"],"format":"int64","description":"The version of the enquiry","example":1},"customerId":{"type":["string","null"],"description":"The customer ID associated with the enquiry","example":"572206b5e4b0d7441f638363"},"vesselId":{"type":["string","null"],"description":"The vessel ID associated with the enquiry","example":"572206b5e4b0d7441f638364"},"portId":{"type":["string","null"],"description":"The port ID associated with the enquiry","example":"572206b5e4b0d7441f638365"},"state":{"type":["string","null"],"description":"The state of the enquiry","example":"OPEN"},"dateDelivery":{"type":["string","null"],"description":"Lubes only: The delivery date of the enquiry","example":"2023-10-10T12:00:00Z"},"dateCanceled":{"type":["string","null"],"description":"The cancellation date of the enquiry","example":"2023-10-05T12:00:00Z"},"dateStarted":{"type":["string","null"],"description":"The start date of the enquiry","example":"2023-10-01T12:00:00Z"},"dateOrdered":{"type":["string","null"],"description":"The order date of the enquiry","example":"2023-10-01T12:00:00Z"},"buyerReference":{"type":["string","null"],"description":"The buyer reference for the enquiry","example":"123-XYZ"},"enquiryNumber":{"type":["string","null"],"description":"The enquiry number","example":"CL-123"},"cancelReason":{"type":["string","null"],"description":"The reason for cancellation","example":"Chose a different supplier"},"items":{"type":["array","null"],"description":"The list of items in the enquiry","items":{"$ref":"#/components/schemas/OrderItemMessage"}},"samplekits":{"type":["array","null"],"description":"The list of sample kits in the enquiry","items":{"$ref":"#/components/schemas/SamplekitMessage"}},"createdBy":{"type":["string","null"],"description":"The ID of the user who created the enquiry","example":"572206b5e4b0d7441f638366"},"updatedBy":{"type":["string","null"],"description":"The ID of the user who last updated the enquiry","example":"572206b5e4b0d7441f638367"},"comment":{"type":["string","null"],"description":"The comment on the enquiry","example":"Urgent delivery required"},"chosenOrderId":{"type":["string","null"],"description":"The chosen order ID for the enquiry","example":"572206b5e4b0d7441f638367"},"spot":{"type":["boolean","null"],"description":"Whether the enquiry is a spot enquiry","example":true},"receiverSupplierIds":{"type":["array","null"],"description":"The list of receiver supplier IDs","items":{"type":"string"}},"assignedSupplierIds":{"type":["array","null"],"description":"The list of assigned supplier IDs","items":{"type":"string"}},"excludeSupplierGroupIds":{"type":["array","null"],"description":"The list of excluded supplier group IDs","items":{"type":"string"}},"attributes":{"type":["object","null"],"additionalProperties":{"type":"string"},"description":"The attributes of the enquiry"},"creationComment":{"type":["string","null"],"description":"The creation comment for the enquiry","example":"Initial creation"},"agentId":{"type":["string","null"],"description":"The agent ID associated with the enquiry","example":"572206b5e4b0d7441f638368"},"source":{"type":["string","null"],"description":"The source of the enquiry","example":"ERP_SYSTEM"},"type":{"type":["string","null"],"description":"The type of the enquiry","example":"LUBES"},"fileIds":{"type":["array","null"],"description":"The list of file IDs associated with the enquiry","items":{"type":"string"}},"approvalRequestState":{"type":["string","null"],"description":"The approval request state of the enquiry","example":"PENDING"}}}},"components/schemas/CreateOrderItemMessage":{"id":"components/schemas/CreateOrderItemMessage","kind":"json-schema","title":"CreateOrderItemMessage","data":{"type":"object","description":"Create order Item model","properties":{"productId":{"type":["string","null"],"description":"The product ID of the item","example":"572206b5e4b0d7441f638364"},"packType":{"type":["string","null"],"description":"The pack type of the item","example":"DRUMS"},"unitSize":{"type":["number","null"],"description":"The unit size of the pack type","example":208},"units":{"type":["number","null"],"description":"The number of units of the item","example":10},"unit":{"type":["string","null"],"description":"The unit of the item","example":"L"},"deleted":{"type":"boolean","description":"Lubes only: Whether the item was deleted","example":false},"sourceValues":{"oneOf":[{"$ref":"#/components/schemas/ItemSourceValuesMessage"},{"type":"null"}]}},"required":["deleted"]}},"components/schemas/CreateSamplekitMessage":{"id":"components/schemas/CreateSamplekitMessage","kind":"json-schema","title":"CreateSamplekitMessage","data":{"type":"object","properties":{"name":{"type":["string","null"],"description":"The name of the sample kit","example":"Sample Kit A"},"quantity":{"type":["integer","null"],"format":"int64","description":"The quantity of the sample kit","example":10},"deleted":{"type":"boolean","description":"Whether the sample kit was deleted","example":false}},"required":["deleted"]}},"components/schemas/CreateUpdateEnquiryMessage":{"id":"components/schemas/CreateUpdateEnquiryMessage","kind":"json-schema","title":"CreateUpdateEnquiryMessage","data":{"type":"object","description":"Create or update enquiry model","properties":{"vesselId":{"type":["string","null"],"description":"The vessel ID associated with the enquiry","example":"572206b5e4b0d7441f638364"},"portId":{"type":["string","null"],"description":"The port ID associated with the enquiry","example":"572206b5e4b0d7441f638365"},"buyerReference":{"type":["string","null"],"description":"The buyer reference for the enquiry","example":"123-XYZ"},"agentId":{"type":["string","null"],"description":"The agent ID associated with the enquiry","example":"572206b5e4b0d7441f638368"},"comment":{"type":["string","null"],"description":"The comment on the enquiry","example":"Urgent delivery required"},"items":{"type":["array","null"],"description":"The list of items in the enquiry","items":{"$ref":"#/components/schemas/CreateOrderItemMessage"}},"receiverSupplierIds":{"type":["array","null"],"description":"The list of receiver supplier IDs","items":{"type":"string"}},"samplekits":{"type":["array","null"],"description":"The list of sample kits in the enquiry","items":{"$ref":"#/components/schemas/CreateSamplekitMessage"}},"spot":{"type":"boolean","description":"Whether the enquiry is a spot enquiry","example":true},"state":{"type":["string","null"],"description":"The state of the enquiry","enum":["DRAFT","OPEN","CLOSED","CANCELED"],"example":"OPEN"},"chosenOrderId":{"type":["string","null"],"description":"The chosen order ID for the enquiry","example":"572206b5e4b0d7441f638367"},"type":{"type":["string","null"],"description":"The type of the enquiry","example":"LUBES"},"cancelReason":{"type":["string","null"],"description":"The reason for cancellation","example":"Chose a different supplier"},"creationComment":{"type":["string","null"],"description":"The creation comment for the enquiry","example":"Initial creation"},"attributes":{"type":["object","null"],"additionalProperties":{"type":"string"},"description":"The attributes of the enquiry"},"source":{"type":["string","null"],"description":"The source of the enquiry","example":"PUBLIC_API"},"dateDelivery":{"type":["string","null"],"description":"Lubes only: The delivery date of the enquiry","example":"2023-10-10T12:00:00Z"},"fileIds":{"type":["array","null"],"description":"The list of file IDs associated with the enquiry","items":{"type":"string"}}},"required":["spot"]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","description":"Model for a single error","properties":{"code":{"type":"string","description":"The error code of the error that was thrown","example":"REQUIRED"},"message":{"type":"string","description":"Human readable description of the error","example":"Field is required"},"path":{"type":"string","description":"The JSON path where the error occurred","example":".agent.id"}},"required":["code","message","path"]}},"components/schemas/ValidationErrorResponse":{"id":"components/schemas/ValidationErrorResponse","kind":"json-schema","title":"ValidationErrorResponse","data":{"type":"object","description":"Model for all cases of errors","properties":{"code":{"type":"string","description":"The error code of the error that was thrown","example":"VALIDATION_FAILED","readOnly":true},"errors":{"type":["array","null"],"description":"The list of all errors that happened at the request","items":{"$ref":"#/components/schemas/Error"}}},"required":["code"]}},"components/schemas/AddressMessage":{"id":"components/schemas/AddressMessage","kind":"json-schema","title":"AddressMessage","data":{"type":"object","description":"Model for address details","properties":{"street":{"type":["string","null"],"description":"The street name","example":"Axel Springer Platz"},"streetNumber":{"type":["string","null"],"description":"The street number","example":"3"},"zipCode":{"type":["string","null"],"description":"The zip code of the city","example":"20355"},"city":{"type":["string","null"],"description":"The name of the city","example":"Hamburg"},"country":{"type":["string","null"],"description":"The name of the country","example":"Germany"}}}},"components/schemas/ContactMessage":{"id":"components/schemas/ContactMessage","kind":"json-schema","title":"ContactMessage","data":{"type":"object","description":"Model for contact details","properties":{"name":{"type":["string","null"],"description":"The name of the contact","example":"Jane Doe"},"phoneNumber":{"type":["string","null"],"description":"The phone number of the contact","example":"+1 234 567 890"},"emailAddress":{"type":["string","null"],"description":"The email address of the contact","example":"jane.doe@closelink.net"},"faxNumber":{"type":["string","null"],"description":"The fax number of the contact","example":"+1 987 654 321"}}}},"components/schemas/AgentMessage":{"id":"components/schemas/AgentMessage","kind":"json-schema","title":"AgentMessage","data":{"type":"object","description":"Agent model","properties":{"id":{"type":["string","null"],"description":"The ID of the agent","example":"5fc4f3b053e79838873f72e9"},"name":{"type":["string","null"],"description":"The name of the agency","example":"Port Agent Closelink GmbH"},"address":{"oneOf":[{"$ref":"#/components/schemas/AddressMessage"},{"type":"null"}]},"contact":{"oneOf":[{"$ref":"#/components/schemas/ContactMessage"},{"type":"null"}]},"loCodes":{"type":["array","null"],"description":"List of loCodes for an agency","items":{"type":"string"}},"note":{"type":["string","null"],"description":"Additional notes for an agent","example":"Super important note!"},"customerId":{"type":["string","null"],"description":"The customer ID of an agent","example":"572206b5e4b0d7441f638363"},"externalId":{"type":["string","null"],"description":"The external ID of an agent","example":"AGENT-123-ID"}}}},"components/schemas/AgentsMessage":{"id":"components/schemas/AgentsMessage","kind":"json-schema","title":"AgentsMessage","data":{"type":"object","description":"List request model of AgentMessage","properties":{"agents":{"type":"array","description":"List of agents","items":{"$ref":"#/components/schemas/AgentMessage"}}},"required":["agents"]}},"components/schemas/RemainingOnBoardRequestMessage":{"id":"components/schemas/RemainingOnBoardRequestMessage","kind":"json-schema","title":"RemainingOnBoardRequestMessage","data":{"type":"object","description":"Remaining on board request model","properties":{"imo":{"type":"string","description":"The IMO of the vessel reporting the remaining on board information","example":"9776171"},"dateMeasured":{"type":"string","description":"The date when the remaining on board information were measured","example":"2024-03-01T00:00:00.000Z"},"quantity":{"type":"integer","format":"int32","description":"The quantity in liters","example":15000},"vesselTankId":{"type":"string","description":"The vessel tank ID","example":"5fc4f3b053e12538873f72e9"},"source":{"type":["string","null"],"default":"PUBLIC_API","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source system that created the remaining on board entry. Defaults to PUBLIC_API when omitted."},"children":[]}]}]}],"example":"stock-import-lambda"}},"required":["dateMeasured","imo","quantity","vesselTankId"]}},"components/schemas/RemainingOnBoardListRequestMessage":{"id":"components/schemas/RemainingOnBoardListRequestMessage","kind":"json-schema","title":"RemainingOnBoardListRequestMessage","data":{"type":"object","description":"List request model of RemainingOnBoardRequestMessage","properties":{"remainingOnBoard":{"type":"array","description":"List of remaining on board information","items":{"$ref":"#/components/schemas/RemainingOnBoardRequestMessage"}}},"required":["remainingOnBoard"]}},"components/schemas/RemainingOnBoardImportEntryMessage":{"id":"components/schemas/RemainingOnBoardImportEntryMessage","kind":"json-schema","title":"RemainingOnBoardImportEntryMessage","data":{"type":"object","description":"Remaining on board entry for a single tank. Either vesselTankCategory or vesselTankId must be provided to identify the tank.","properties":{"vesselTankCategory":{"type":["string","null"],"description":"The vessel tank category identifier. Required if vesselTankId is not provided. Must match one of the VesselTankMessage.category values.","enum":["ME_CYL_HS","ME_CYL_HS_140_BN","ME_CYL_HS_100_BN","ME_CYL_HS_70_BN","ME_CYL_LS_40_BN","ME_CYL_LS","ME_CYL_ULS_17_BN","ME_CYL_ULS_25_BN","ME_CIRC_40_BN","ME_CIRC_30_BN","ME_CIRC_20_BN","ME_CIRC_LT_20_BN","ME_CIRC","AE_CIRC","AE_CIRC_20_BN","AE_CIRC_30_BN","AE_CIRC_40_BN","AE_CIRC_50_BN","STERNTUBE","RED_GEAR","ST_GEAR","BOW_THRUST","CPP","GEAR_OIL","HYDR_OIL","THERM_OIL","ME_CYL_ULS","AE_CIRC_ULS","BOB","BOB_BASE_OIL","OTHER"],"example":"ME_CYL_HS"},"vesselTankId":{"type":["string","null"],"description":"The vessel tank identifier. Required if vesselTankCategory is not provided.","example":"5fc4f3b053e12538873f72e9"},"quantity":{"type":"integer","format":"int64","description":"The quantity in liters","example":15000},"dateMeasured":{"type":"string","format":"date-time","description":"The date when the remaining on board information were measured","example":"2026-04-16T10:00:00Z"},"source":{"type":["string","null"],"default":"PUBLIC_API","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source system that created the remaining on board entry. Defaults to PUBLIC_API when omitted."},"children":[]}]}]}],"example":"stock-import-lambda"}},"required":["dateMeasured","quantity"]}},"components/schemas/VesselRemainingOnBoardImportMessage":{"id":"components/schemas/VesselRemainingOnBoardImportMessage","kind":"json-schema","title":"VesselRemainingOnBoardImportMessage","data":{"type":"object","description":"Remaining on board update for a single vessel","properties":{"imo":{"type":"string","description":"The IMO of the vessel reporting the remaining on board information","example":"9776171"},"remainingOnBoard":{"type":"array","description":"Remaining on board entries for the vessel","items":{"$ref":"#/components/schemas/RemainingOnBoardImportEntryMessage"}}},"required":["imo","remainingOnBoard"]}},"components/schemas/RemainingOnBoardImportRequestMessage":{"id":"components/schemas/RemainingOnBoardImportRequestMessage","kind":"json-schema","title":"RemainingOnBoardImportRequestMessage","data":{"type":"object","description":"Remaining on board import request model","properties":{"vessels":{"type":"array","description":"List of remaining on board updates per vessel","items":{"$ref":"#/components/schemas/VesselRemainingOnBoardImportMessage"}}},"required":["vessels"]}},"components/schemas/VesselRemainingOnBoardImportResultMessage":{"id":"components/schemas/VesselRemainingOnBoardImportResultMessage","kind":"json-schema","title":"VesselRemainingOnBoardImportResultMessage","data":{"type":"object","description":"Import result for the remaining on board entries of a single vessel","properties":{"imo":{"type":"string","description":"The IMO of the vessel","example":"9776171"},"action":{"type":"string","description":"The action that was taken for the vessel","enum":["IMPORTED","SKIPPED"]},"importedCount":{"type":"integer","format":"int64","description":"Number of successfully imported entries for this vessel"},"skippedCount":{"type":"integer","format":"int64","description":"Number of skipped entries for this vessel"},"message":{"type":["string","null"],"description":"Optional message providing additional context for the action"}},"required":["action","imo","importedCount","skippedCount"]}},"components/schemas/ImportedRemainingOnBoardMessage":{"id":"components/schemas/ImportedRemainingOnBoardMessage","kind":"json-schema","title":"ImportedRemainingOnBoardMessage","data":{"type":"object","description":"Details for a successfully imported remaining on board entry","properties":{"id":{"type":"string","description":"The identifier of the imported remaining on board entry"},"imo":{"type":"string","description":"The IMO of the vessel","example":"9776171"},"vesselTankCategory":{"type":"string","description":"The vessel tank category identifier. Matches one of the VesselTankMessage.category values.","enum":["ME_CYL_HS","ME_CYL_HS_140_BN","ME_CYL_HS_100_BN","ME_CYL_HS_70_BN","ME_CYL_LS_40_BN","ME_CYL_LS","ME_CYL_ULS_17_BN","ME_CYL_ULS_25_BN","ME_CIRC_40_BN","ME_CIRC_30_BN","ME_CIRC_20_BN","ME_CIRC_LT_20_BN","ME_CIRC","AE_CIRC","AE_CIRC_20_BN","AE_CIRC_30_BN","AE_CIRC_40_BN","AE_CIRC_50_BN","STERNTUBE","RED_GEAR","ST_GEAR","BOW_THRUST","CPP","GEAR_OIL","HYDR_OIL","THERM_OIL","ME_CYL_ULS","AE_CIRC_ULS","BOB","BOB_BASE_OIL","OTHER"],"example":"ME_CYL_HS"},"vesselTankId":{"type":"string","description":"The vessel tank identifier","example":"5fc4f3b053e12538873f72e9"},"quantity":{"type":"integer","format":"int64","description":"The quantity in liters","example":15000},"dateMeasured":{"type":"string","format":"date-time","description":"The date when the remaining on board information were measured","example":"2026-04-16T10:00:00Z"},"source":{"type":["string","null"],"description":"The source system that created the imported remaining on board entry","example":"stock-import-lambda","readOnly":true}},"required":["dateMeasured","id","imo","quantity","vesselTankCategory","vesselTankId"]}},"components/schemas/SkippedRemainingOnBoardMessage":{"id":"components/schemas/SkippedRemainingOnBoardMessage","kind":"json-schema","title":"SkippedRemainingOnBoardMessage","data":{"type":"object","description":"Details for a skipped remaining on board entry","properties":{"imo":{"type":"string","description":"The IMO of the vessel","example":"9776171"},"vesselTankCategory":{"type":["string","null"],"description":"The vessel tank category identifier. Matches one of the VesselTankMessage.category values.","enum":["ME_CYL_HS","ME_CYL_HS_140_BN","ME_CYL_HS_100_BN","ME_CYL_HS_70_BN","ME_CYL_LS_40_BN","ME_CYL_LS","ME_CYL_ULS_17_BN","ME_CYL_ULS_25_BN","ME_CIRC_40_BN","ME_CIRC_30_BN","ME_CIRC_20_BN","ME_CIRC_LT_20_BN","ME_CIRC","AE_CIRC","AE_CIRC_20_BN","AE_CIRC_30_BN","AE_CIRC_40_BN","AE_CIRC_50_BN","STERNTUBE","RED_GEAR","ST_GEAR","BOW_THRUST","CPP","GEAR_OIL","HYDR_OIL","THERM_OIL","ME_CYL_ULS","AE_CIRC_ULS","BOB","BOB_BASE_OIL","OTHER"],"example":"ME_CYL_HS"},"vesselTankId":{"type":["string","null"],"description":"The vessel tank identifier","example":"5fc4f3b053e12538873f72e9"},"vesselIndex":{"type":"integer","format":"int64","description":"The index of the vessel in the request payload"},"stockIndex":{"type":["integer","null"],"format":"int64","description":"The index of the stock entry within the vessel"},"code":{"type":"string","description":"The error code describing why the entry was skipped","example":"IMO_NOT_IN_GROUP"},"level":{"type":"string","description":"The severity of the log entry","enum":["INFO","ERROR"]},"message":{"type":"string","description":"Human readable description of why the entry was skipped"}},"required":["code","imo","level","message","vesselIndex"]}},"components/schemas/RemainingOnBoardImportResponseMessage":{"id":"components/schemas/RemainingOnBoardImportResponseMessage","kind":"json-schema","title":"RemainingOnBoardImportResponseMessage","data":{"type":"object","description":"Import summary for a remaining on board import request","properties":{"importedCount":{"type":"integer","format":"int64","description":"Number of successfully imported remaining on board entries"},"skippedCount":{"type":"integer","format":"int64","description":"Number of skipped remaining on board entries"},"vessels":{"type":"array","description":"Import result for the remaining on board entries of each vessel","items":{"$ref":"#/components/schemas/VesselRemainingOnBoardImportResultMessage"}},"importedRemainingOnBoard":{"type":"array","description":"Details for each successfully imported remaining on board entry","items":{"$ref":"#/components/schemas/ImportedRemainingOnBoardMessage"}},"skippedRemainingOnBoard":{"type":"array","description":"Details for each skipped remaining on board entry","items":{"$ref":"#/components/schemas/SkippedRemainingOnBoardMessage"}}},"required":["importedCount","importedRemainingOnBoard","skippedCount","skippedRemainingOnBoard","vessels"]}},"components/schemas/CreateSurchargeMessage":{"id":"components/schemas/CreateSurchargeMessage","kind":"json-schema","title":"CreateSurchargeMessage","data":{"type":"object","description":"Message containing details of a surcharge","properties":{"name":{"type":["string","null"],"description":"Name of the surcharge","example":"Crane tax"},"value":{"oneOf":[{"$ref":"#/components/schemas/MoneyMessage"},{"type":"null"}]},"deleted":{"type":"boolean","description":"Indicates if the surcharge is deleted","example":false},"surchargeType":{"type":["string","null"],"description":"Type of the surcharge","enum":["SHORT_NOTICE","BARGE_CHARGE","MINIMUM_QUANTITY","PORT_FEE","CUSTOMS","CUSTOM","AGENCY_FEES","FREIGHT_AND_TRANSPORTATION_CHARGE","PUMPING"],"example":"BARGE_CHARGE"}},"required":["deleted"]}},"components/schemas/CreateSurchargesMessage":{"id":"components/schemas/CreateSurchargesMessage","kind":"json-schema","title":"CreateSurchargesMessage","data":{"type":"object","description":"List message containing details of surcharges","properties":{"surcharges":{"type":"array","items":{"$ref":"#/components/schemas/CreateSurchargeMessage"}}},"required":["surcharges"]}},"components/schemas/OfferChangesMessage":{"id":"components/schemas/OfferChangesMessage","kind":"json-schema","title":"OfferChangesMessage","data":{"type":"object","description":"Changes in the offer","properties":{"portChanged":{"type":"boolean","description":"Indicates if the port has changed","example":false},"dateDeliveryChanged":{"type":"boolean","description":"Indicates if the delivery date has changed","example":false},"supplyModeChanged":{"type":"boolean","description":"Indicates if the supply mode has changed","example":false},"paymentTermReferenceChanged":{"type":"boolean","description":"Indicates if the payment term reference has changed","example":false},"paymentTermReferenceDaysChanged":{"type":"boolean","description":"Indicates if the payment term reference days have changed","example":false},"buyerReferenceChanged":{"type":"boolean","description":"Indicates if the buyer reference has changed","example":false},"vendorReferenceChanged":{"type":"boolean","description":"Indicates if the vendor reference has changed","example":false},"noticeDaysChanged":{"type":"boolean","description":"Indicates if the notice days have changed","example":false}},"required":["buyerReferenceChanged","dateDeliveryChanged","noticeDaysChanged","paymentTermReferenceChanged","paymentTermReferenceDaysChanged","portChanged","supplyModeChanged","vendorReferenceChanged"]}},"components/schemas/OfferItemResponseMessage":{"id":"components/schemas/OfferItemResponseMessage","kind":"json-schema","title":"OfferItemResponseMessage","data":{"type":"object","description":"Item model","properties":{"index":{"type":["integer","null"],"format":"int32","description":"The index of the item","example":1},"productId":{"type":["string","null"],"description":"The product ID of the item","example":"572206b5e4b0d7441f638364"},"packType":{"type":["string","null"],"description":"The pack type of the item","enum":["BULK","DRUMS","IBCS","PAIL","BULK_EX_IBC","BULK_EX_DRUMS","BOTTLE","PACK","CARTON"],"example":"DRUMS"},"unitSize":{"type":["number","null"],"description":"The unit size of the item","example":208},"units":{"type":["number","null"],"description":"The number of units of the item","example":10},"unit":{"type":["string","null"],"description":"The unit of the item","enum":["L","KG","MT","BARREL","MWH","MMBTU","PIECE"],"example":"L"},"volume":{"type":["number","null"],"description":"The volume of the item","example":15},"total":{"oneOf":[{"$ref":"#/components/schemas/MoneyMessage"},{"type":"null"}]},"price":{"oneOf":[{"$ref":"#/components/schemas/MoneyMessage"},{"type":"null"}]},"added":{"type":["boolean","null"],"description":"Whether the item was added","example":true},"deleted":{"type":["boolean","null"],"description":"Whether the item was deleted","example":false},"changes":{"oneOf":[{"$ref":"#/components/schemas/ItemChangesMessage"},{"type":"null"}]}}}},"components/schemas/SurchargeChangesMessage":{"id":"components/schemas/SurchargeChangesMessage","kind":"json-schema","title":"SurchargeChangesMessage","data":{"type":"object","description":"Details of changes in the surcharge","properties":{"nameChanged":{"type":"boolean","description":"Indicates if the name has changed","example":false},"valueChanged":{"type":"boolean","description":"Indicates if the value has changed","example":false},"surchargeTypeChanged":{"type":"boolean","description":"Indicates if the surcharge type has changed","example":false}},"required":["nameChanged","surchargeTypeChanged","valueChanged"]}},"components/schemas/SurchargeMessage":{"id":"components/schemas/SurchargeMessage","kind":"json-schema","title":"SurchargeMessage","data":{"type":"object","description":"Message containing details of a surcharge","properties":{"index":{"type":["integer","null"],"format":"int32","description":"Index of the surcharge","example":1},"name":{"type":["string","null"],"description":"Name of the surcharge","example":"Extra fee"},"value":{"oneOf":[{"$ref":"#/components/schemas/MoneyMessage"},{"type":"null"}]},"changes":{"oneOf":[{"$ref":"#/components/schemas/SurchargeChangesMessage"},{"type":"null"}]},"added":{"type":["boolean","null"],"description":"Indicates if the surcharge is added","example":false},"deleted":{"type":["boolean","null"],"description":"Indicates if the surcharge is deleted","example":false},"surchargeType":{"type":["string","null"],"description":"Type of the surcharge","example":"BARGE_CHARGE"}}}},"components/schemas/OfferMessage":{"id":"components/schemas/OfferMessage","kind":"json-schema","title":"OfferMessage","data":{"type":"object","description":"Offer model","properties":{"id":{"type":["string","null"],"description":"ID of the offer","example":"5abb6605e4b05f80261fdf37"},"dateCreated":{"type":["string","null"],"description":"Date when the offer was created","example":"2025-01-01T00:00:00Z"},"dateUpdated":{"type":["string","null"],"description":"Date when the offer was last updated","example":"2025-01-02T00:00:00Z"},"enquiryId":{"type":["string","null"],"description":"ID of the enquiry","example":"5abb6605e4b05f80261fdf37"},"customerId":{"type":["string","null"],"description":"ID of the customer","example":"5abb6605e4b05f80261fdf37"},"supplierId":{"type":["string","null"],"description":"ID of the supplier","example":"5abb6605e4b05f80261fdf37"},"enquiryType":{"type":["string","null"],"description":"Type of the enquiry","enum":["SPOT","ASSIGNED","FORWARDED","ANONYMOUS"],"example":"ASSIGNED"},"state":{"type":["string","null"],"description":"State of the offer","enum":["DRAFT","ENQUIRY","QUOTED","ORDER","CUSTOMER_ADJUSTED","SUPPLIER_ADJUSTED","CONFIRMED","ACKNOWLEDGED","CANCELED","DELIVERED","INVOICED","QUOTE_DECLINED","QUOTE_CANCELED","ENQUIRY_DECLINED","ENQUIRY_CANCELED","ENQUIRY_EXPIRED"],"example":"CONFIRMED"},"dateDelivered":{"type":["string","null"],"description":"Date when the offer was delivered","example":"2025-01-03T00:00:00Z"},"dateConfirmation":{"type":["string","null"],"description":"Date when the offer was confirmed","example":"2025-01-04T00:00:00Z"},"dateOrdered":{"type":["string","null"],"description":"Date when the offer was ordered","example":"2025-01-05T00:00:00Z"},"dateEnquired":{"type":["string","null"],"description":"Date when the enquiry was made","example":"2025-01-06T00:00:00Z"},"dateQuoted":{"type":["string","null"],"description":"Date when the offer was quoted","example":"2025-01-07T00:00:00Z"},"dateCanceled":{"type":["string","null"],"description":"Date when the offer was canceled","example":"2025-01-08T00:00:00Z"},"dateAcknowledged":{"type":["string","null"],"description":"Date when the offer was acknowledged","example":"2025-01-09T00:00:00Z"},"dateInvoiced":{"type":["string","null"],"description":"Date when the offer was invoiced","example":"2025-01-10T00:00:00Z"},"vendorReference":{"type":["string","null"],"description":"Vendor reference","example":"VR-12345"},"offerNumber":{"type":["string","null"],"description":"Offer number","example":"CL-1AB2CD-XY"},"cancelReason":{"type":["string","null"],"description":"Reason for cancellation","example":"Delivery not needed anymore"},"volume":{"type":["number","null"],"description":"Volume of the offer","example":1000},"ppl":{"oneOf":[{"$ref":"#/components/schemas/MoneyMessage"},{"type":"null"}]},"total":{"oneOf":[{"$ref":"#/components/schemas/MoneyMessage"},{"type":"null"}]},"createdBy":{"type":["string","null"],"description":"ID of the user who created the offer","example":"5abb6605e4b05f80261fdf37"},"updatedBy":{"type":["string","null"],"description":"ID of the user who updated the offer","example":"5abb6605e4b05f80261fdf37"},"orderedBy":{"type":["string","null"],"description":"ID of the user who ordered the offer","example":"5abb6605e4b05f80261fdf37"},"paymentTermReference":{"type":["string","null"],"description":"Payment term reference","enum":["DAYS_AFTER_DELIVERY","DAYS_AFTER_NOMINATION","DAYS_AFTER_INVOICE_DATE","PREPAYMENT"],"example":"DAYS_AFTER_DELIVERY"},"paymentTermReferenceDays":{"type":["integer","null"],"format":"int64","description":"Payment term reference days","example":30},"supplyMode":{"type":["string","null"],"description":"Supply mode","enum":["BARGE","TRUCK","BARGEANDTRUCK","EX_WHARF","EX_PIPE"],"example":"BARGE"},"supplyModeIncludesDeliveryCosts":{"type":["boolean","null"],"description":"Indicates if the supply mode includes delivery costs","example":true},"noticeDays":{"type":["integer","null"],"format":"int64","description":"Notice days","example":7},"priceComplete":{"type":["boolean","null"],"description":"Indicates if the price is complete","example":true},"fileIds":{"type":["array","null"],"description":"List of file IDs","example":["67c586ef358cb50eab2a63c7","5abb6605e4b05f80261fdf37"],"items":{"type":"string"}},"changes":{"oneOf":[{"$ref":"#/components/schemas/OfferChangesMessage"},{"type":"null"}]},"portId":{"type":["string","null"],"description":"ID of the port","example":"5abb6605e4b05f80261fdf37"},"dateDelivery":{"type":["string","null"],"description":"Date of delivery","example":"2025-01-11T00:00:00Z"},"buyerReference":{"type":["string","null"],"description":"Buyer reference","example":"BUYER-REF123"},"vesselId":{"type":["string","null"],"description":"ID of the vessel","example":"5abb6605e4b05f80261fdf37"},"items":{"type":["array","null"],"description":"List of offer items","items":{"$ref":"#/components/schemas/OfferItemResponseMessage"}},"surcharges":{"type":["array","null"],"description":"List of surcharges","items":{"$ref":"#/components/schemas/SurchargeMessage"}},"samplekits":{"type":["array","null"],"description":"List of sample kits","items":{"$ref":"#/components/schemas/SamplekitMessage"}},"agentId":{"type":["string","null"],"description":"ID of the agent","example":"5abb6605e4b05f80261fdf37"},"type":{"type":["string","null"],"description":"Type of the offer","enum":["LUBES","FUEL"],"example":"LUBES"}}}},"components/schemas/PatchSurchargeMessage":{"id":"components/schemas/PatchSurchargeMessage","kind":"json-schema","title":"PatchSurchargeMessage","data":{"type":"object","description":"Model for patching an offer surcharge","properties":{"index":{"type":["integer","null"],"format":"int32","description":"Index of the surcharge","example":1},"name":{"type":["string","null"],"description":"Name of the surcharge","example":"Extra fee"},"value":{"oneOf":[{"$ref":"#/components/schemas/MoneyMessage"},{"type":"null"}]},"deleted":{"type":["boolean","null"],"description":"Indicates if the surcharge is deleted","example":false},"surchargeType":{"type":["string","null"],"description":"Type of the surcharge","enum":["SHORT_NOTICE","BARGE_CHARGE","MINIMUM_QUANTITY","PORT_FEE","CUSTOMS","CUSTOM","AGENCY_FEES","FREIGHT_AND_TRANSPORTATION_CHARGE","PUMPING"],"example":"BARGE_CHARGE"}}}},"components/schemas/PatchSurchargesMessage":{"id":"components/schemas/PatchSurchargesMessage","kind":"json-schema","title":"PatchSurchargesMessage","data":{"type":"object","description":"Message containing a list of offer surcharges which will be patched","properties":{"surcharges":{"type":"array","description":"List of surcharges to be patched","items":{"$ref":"#/components/schemas/PatchSurchargeMessage"}}},"required":["surcharges"]}},"components/schemas/CreateOfferMessageRequest":{"id":"components/schemas/CreateOfferMessageRequest","kind":"json-schema","title":"CreateOfferMessageRequest","data":{"type":"object","description":"Model for creating an offer message","properties":{"message":{"type":"string","description":"Message content","example":"Thanks, changes noted for\n\tProduct 1\n\tProduct 2\nBest regards, John Doe"}},"required":["message"]}},"components/schemas/CreateOfferItemMessage":{"id":"components/schemas/CreateOfferItemMessage","kind":"json-schema","title":"CreateOfferItemMessage","data":{"type":"object","description":"Model for creating an offer item","properties":{"productId":{"type":["string","null"],"description":"The product ID","example":"67c586ef358cb50eab2a63c7"},"price":{"oneOf":[{"$ref":"#/components/schemas/MoneyMessage"},{"type":"null"}]},"packType":{"type":["string","null"],"description":"Type of packaging","enum":["BULK","DRUMS","IBCS","PAIL","BULK_EX_IBC","BULK_EX_DRUMS","BOTTLE","PACK","CARTON"],"example":"DRUMS"},"unitSize":{"type":["number","null"],"description":"Size of the unit","example":208},"units":{"type":["number","null"],"description":"Number of units","example":20},"unit":{"type":["string","null"],"description":"Unit of measurement","enum":["L","KG","MT","BARREL","MWH","MMBTU","PIECE"],"example":"L"},"deleted":{"type":"boolean","description":"Indicates if the item is deleted","example":false}},"required":["deleted"]}},"components/schemas/CreateOfferItemsMessage":{"id":"components/schemas/CreateOfferItemsMessage","kind":"json-schema","title":"CreateOfferItemsMessage","data":{"type":"object","description":"Message containing a list of offer items","properties":{"items":{"type":"array","description":"List of offer items","items":{"$ref":"#/components/schemas/CreateOfferItemMessage"}}},"required":["items"]}},"components/schemas/PatchItemMessage":{"id":"components/schemas/PatchItemMessage","kind":"json-schema","title":"PatchItemMessage","data":{"type":"object","description":"Model for patching an offer item","properties":{"index":{"type":["integer","null"],"format":"int32","description":"Index of the item","example":1},"productId":{"type":["string","null"],"description":"ID of the product","example":"5abb6605e4b05f80261fdf37"},"price":{"oneOf":[{"$ref":"#/components/schemas/MoneyMessage"},{"type":"null"}]},"packType":{"type":["string","null"],"description":"Type of the pack","enum":["BULK","DRUMS","IBCS","PAIL","BULK_EX_IBC","BULK_EX_DRUMS","BOTTLE","PACK","CARTON"],"example":"DRUMS"},"unitSize":{"type":["number","null"],"description":"Size of the unit","example":200},"units":{"type":["number","null"],"description":"Number of units","example":10},"unit":{"type":["string","null"],"description":"Unit of measurement","enum":["L","KG","MT","BARREL","MWH","MMBTU","PIECE"],"example":"L"},"deleted":{"type":["boolean","null"],"description":"Indicates if the item is deleted","example":false}}}},"components/schemas/PatchOfferItemsMessage":{"id":"components/schemas/PatchOfferItemsMessage","kind":"json-schema","title":"PatchOfferItemsMessage","data":{"type":"object","description":"Message containing a list of offer items which will be patched","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PatchItemMessage"}}},"required":["items"]}},"components/schemas/OfferInternalFileMessage":{"id":"components/schemas/OfferInternalFileMessage","kind":"json-schema","title":"OfferInternalFileMessage","data":{"type":"object","description":"Offer internal file response model","properties":{"id":{"type":"string","description":"The unique identifier of the file","example":"507f1f77bcf86cd799439011"},"companyId":{"type":"string","description":"The company ID associated with the file","example":"507f1f77bcf86cd799439012"},"fileName":{"type":"string","description":"The name of the file","example":"internal-document.pdf"},"dateCreated":{"type":"string","description":"The date when the file was created","example":"2025-01-15T10:30:00Z"},"createdBy":{"type":"string","description":"The user who created the file","example":"John Doe"},"offerId":{"type":"string","description":"The offer ID associated with the file","example":"507f1f77bcf86cd799439013"}},"required":["companyId","createdBy","dateCreated","fileName","id","offerId"]}},"components/schemas/OfferInternalFilesResponse":{"id":"components/schemas/OfferInternalFilesResponse","kind":"json-schema","title":"OfferInternalFilesResponse","data":{"type":"object","description":"Response containing offer internal files","properties":{"internalFiles":{"type":"array","items":{"$ref":"#/components/schemas/OfferInternalFileMessage"}}},"required":["internalFiles"]}},"components/schemas/OfferFileMessage":{"id":"components/schemas/OfferFileMessage","kind":"json-schema","title":"OfferFileMessage","data":{"type":"object","description":"Offer file response model","properties":{"id":{"type":"string","description":"The unique identifier of the file","example":"507f1f77bcf86cd799439011"},"companyId":{"type":"string","description":"The company ID associated with the file","example":"507f1f77bcf86cd799439012"},"fileName":{"type":"string","description":"The name of the file","example":"offer-document.pdf"}},"required":["companyId","fileName","id"]}},"components/schemas/CreateIntegrationMessageRequestMessage":{"id":"components/schemas/CreateIntegrationMessageRequestMessage","kind":"json-schema","title":"CreateIntegrationMessageRequestMessage","data":{"type":"object","description":"Request model of the IntegrationEventMessage","properties":{"logLevel":{"type":"string","description":"Log Level","enum":["INFO","WARN","ERROR"],"example":"INFO"},"integrationType":{"type":"string","description":"Type of message","example":"ROB"},"userType":{"type":"string","description":"Type of user","enum":["CUSTOMER","SUPPLIER","ADMIN","SYSTEM"],"example":"CUSTOMER"},"message":{"type":"string","description":"Message content","example":"Successfully imported ROBs for IMO 23928112"},"companyId":{"type":["string","null"],"description":"Company ID","example":"65f2ccf7fbe730fe9c66d568"},"additionalFields":{"type":["object","null"],"additionalProperties":{"type":"string"},"description":"Additional custom values","example":{"firstKey":"firstValue","secondKey":"secondValue"}}},"required":["integrationType","logLevel","message","userType"]}},"components/schemas/EnquiryInternalFileMessage":{"id":"components/schemas/EnquiryInternalFileMessage","kind":"json-schema","title":"EnquiryInternalFileMessage","data":{"type":"object","description":"Enquiry internal file response model","properties":{"id":{"type":"string","description":"The unique identifier of the file","example":"507f1f77bcf86cd799439011"},"companyId":{"type":"string","description":"The company ID associated with the file","example":"507f1f77bcf86cd799439012"},"fileName":{"type":"string","description":"The name of the file","example":"internal-document.pdf"},"dateCreated":{"type":"string","description":"The date when the file was created","example":"2025-01-15T10:30:00Z"},"createdBy":{"type":["string","null"],"description":"The user who created the file","example":"507f1f77bcf86cd799439042"},"enquiryId":{"type":"string","description":"The enquiry ID associated with the file","example":"507f1f77bcf86cd799439013"}},"required":["companyId","dateCreated","enquiryId","fileName","id"]}},"components/schemas/EnquiryInternalFilesResponse":{"id":"components/schemas/EnquiryInternalFilesResponse","kind":"json-schema","title":"EnquiryInternalFilesResponse","data":{"type":"object","description":"Response containing enquiry internal files","properties":{"internalFiles":{"type":"array","items":{"$ref":"#/components/schemas/EnquiryInternalFileMessage"}}},"required":["internalFiles"]}},"components/schemas/EnquiryFileMessage":{"id":"components/schemas/EnquiryFileMessage","kind":"json-schema","title":"EnquiryFileMessage","data":{"type":"object","description":"Enquiry file response model","properties":{"id":{"type":"string","description":"The unique identifier of the file","example":"507f1f77bcf86cd799439011"},"companyId":{"type":"string","description":"The company ID associated with the file","example":"507f1f77bcf86cd799439012"},"fileName":{"type":"string","description":"The name of the file","example":"enquiry-document.pdf"}},"required":["companyId","fileName","id"]}},"components/schemas/OfferPatchMessage":{"id":"components/schemas/OfferPatchMessage","kind":"json-schema","title":"OfferPatchMessage","data":{"type":"object","description":"Model for patching an offer","properties":{"vesselId":{"type":["string","null"],"description":"ID of the vessel","example":"5abb6605e4b05f80261fdf37"},"portId":{"type":["string","null"],"description":"ID of the port","example":"5abb6605e4b05f80261fdf37"},"agentId":{"type":["string","null"],"description":"ID of the agent","example":"5abb6605e4b05f80261fdf37"},"state":{"type":["string","null"],"description":"State of the offer","enum":["DRAFT","ENQUIRY","QUOTED","ORDER","CUSTOMER_ADJUSTED","SUPPLIER_ADJUSTED","CONFIRMED","ACKNOWLEDGED","CANCELED","DELIVERED","INVOICED","QUOTE_DECLINED","QUOTE_CANCELED","ENQUIRY_DECLINED","ENQUIRY_CANCELED","ENQUIRY_EXPIRED"],"example":"CONFIRMED"},"dateDelivery":{"type":["string","null"],"description":"Date of delivery","example":"2025-01-11T00:00:00Z"},"buyerReference":{"type":["string","null"],"description":"Buyer reference","example":"BUYER-REF123"},"vendorReference":{"type":["string","null"],"description":"Vendor reference","example":"VR-12345"},"supplyMode":{"type":["string","null"],"description":"Supply mode","enum":["BARGE","TRUCK","BARGEANDTRUCK","EX_WHARF","EX_PIPE"],"example":"BARGE"},"supplyModeIncludesDeliveryCosts":{"type":["boolean","null"],"description":"Indicates if the supply mode includes delivery costs","example":true},"paymentTermReference":{"type":["string","null"],"description":"Payment term reference","enum":["DAYS_AFTER_DELIVERY","DAYS_AFTER_NOMINATION","DAYS_AFTER_INVOICE_DATE","PREPAYMENT"],"example":"DAYS_AFTER_DELIVERY"},"paymentTermReferenceDays":{"type":["integer","null"],"format":"int64","description":"Payment term reference days","example":30},"noticeDays":{"type":["integer","null"],"format":"int64","description":"Notice days","example":7},"cancelReason":{"type":["string","null"],"description":"Reason for cancellation","example":"Delivery not needed anymore"},"fileIds":{"type":["array","null"],"description":"List of file IDs","example":["67c586ef358cb50eab2a63c7","5abb6605e4b05f80261fdf37"],"items":{"type":"string"}}}}},"components/schemas/OfferListMessage":{"id":"components/schemas/OfferListMessage","kind":"json-schema","title":"OfferListMessage","data":{"type":"object","description":"List message containing offers","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/OfferMessage"}}},"required":["content"]}},"components/schemas/MailSettingsMessage":{"id":"components/schemas/MailSettingsMessage","kind":"json-schema","title":"MailSettingsMessage","data":{"type":"object","description":"Mail Settings Message","properties":{"newsletter":{"type":"boolean","description":"Flag that indicates if the company is subscribed to the Closelink newsletter","example":true},"transactional":{"type":"boolean","description":"Flag that indicates if the company is receiving messages of the tool in general","example":true}},"required":["newsletter","transactional"]}},"components/schemas/SupplierMessageV2":{"id":"components/schemas/SupplierMessageV2","kind":"json-schema","title":"SupplierMessageV2","data":{"type":"object","properties":{"id":{"type":"string","description":"Internal ID","example":"5cb6cfc92a8bc367aeec923b","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The ISO date when the object was created","example":"2025-05-01T20:00:00Z","readOnly":true},"dateUpdated":{"type":"string","format":"date-time","description":"The ISO date when the object was last updated","example":"2025-05-01T20:00:00Z","readOnly":true},"name":{"type":"string","description":"Name of the company","example":"Closelink GmbH"},"internalName":{"type":"string","description":"Internal name of the company for internal identification purposes","example":"CL-Hamburg"},"address":{"$ref":"#/components/schemas/AddressMessage"},"phone":{"type":"string","description":"Phone number of the company","example":"+49 40 1234567-0"},"fax":{"type":"string","description":"Fax number of the company","example":"+49 40 1234567-98"},"email":{"type":"string","description":"Email address of the company","example":"hello@closelink.com"},"invoiceMail":{"type":"string","description":"Email address for invoicing","example":"financial-department@closelink.com"},"additionalReceiver":{"type":"array","description":"A list of additional email addresses to receive emails","example":"[cc@closelink.com,bcc@closelink.com]","items":{"type":"string"}},"testCompany":{"type":"boolean","description":"Flag that indicates if a company is a test company","example":false},"gtcAccepted":{"type":"boolean","description":"Flag that indicates if the company has accepted the terms and conditions of Closelink","example":true},"invoiceVAT":{"type":"string","description":"Invoice VAT number","example":9776171},"trial":{"type":"boolean","description":"Flag that indicates if a company is on trial time","example":true},"mailSettings":{"$ref":"#/components/schemas/MailSettingsMessage","description":"Settings for incoming mails"},"invoiceAddress":{"$ref":"#/components/schemas/AddressMessage","description":"Adress of the invoice location"},"supplierGroupId":{"type":"string","description":"The supplier group ID of the company","example":"5cb6cfc92a8bc367aeec923b"},"showGtc":{"type":"boolean","description":"Flag to show the general terms and conditions"},"type":{"type":"string","description":"The type of the company","enum":["LUBES"],"example":"LUBES"}},"required":["email","gtcAccepted","invoiceAddress","mailSettings","name","showGtc","supplierGroupId","testCompany","trial","type"]}},"components/schemas/SuppliersMessage":{"id":"components/schemas/SuppliersMessage","kind":"json-schema","title":"SuppliersMessage","data":{"type":"object","description":"Supplier list message","properties":{"suppliers":{"type":"array","items":{"$ref":"#/components/schemas/SupplierMessageV2"}}},"required":["suppliers"]}},"components/schemas/CustomerMessageV2":{"id":"components/schemas/CustomerMessageV2","kind":"json-schema","title":"CustomerMessageV2","data":{"type":"object","description":"Customer model","properties":{"id":{"type":"string","description":"Internal ID","example":"5cb6cfc92a8bc367aeec923b","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The ISO date when the object was created","example":"2025-05-01T20:00:00Z","readOnly":true},"dateUpdated":{"type":"string","format":"date-time","description":"The ISO date when the object was last updated","example":"2025-05-01T20:00:00Z","readOnly":true},"name":{"type":"string","description":"Name of the company","example":"Closelink GmbH"},"internalName":{"type":"string","description":"Internal name of the company for internal identification purposes","example":"CL-Hamburg"},"address":{"$ref":"#/components/schemas/AddressMessage"},"phone":{"type":"string","description":"Phone number of the company","example":"+49 40 1234567-0"},"fax":{"type":"string","description":"Fax number of the company","example":"+49 40 1234567-98"},"email":{"type":"string","description":"Email address of the company","example":"hello@closelink.com"},"invoiceMail":{"type":"string","description":"Email address for invoicing","example":"financial-department@closelink.com"},"additionalReceiver":{"type":"array","description":"A list of additional email addresses to receive emails","example":"[cc@closelink.com,bcc@closelink.com]","items":{"type":"string"}},"testCompany":{"type":"boolean","description":"Flag that indicates if a company is a test company","example":false},"gtcAccepted":{"type":"boolean","description":"Flag that indicates if the company has accepted the terms and conditions of Closelink","example":true},"invoiceVAT":{"type":"string","description":"Invoice VAT number","example":9776171},"trial":{"type":"boolean","description":"Flag that indicates if a company is on trial time","example":true},"mailSettings":{"$ref":"#/components/schemas/MailSettingsMessage"},"spotAllowed":{"type":"boolean","description":"Indicates if the spot marked is allowed","example":true},"customerGroupId":{"type":"string","description":"The customer group ID of the company","example":"5cb6cfc92a8bc367aeec923b"},"type":{"type":"string","description":"The type of the company","enum":["LUBES"],"example":"LUBES"}},"required":["customerGroupId","email","gtcAccepted","name","spotAllowed","testCompany","trial","type"]}},"components/schemas/CustomersMessage":{"id":"components/schemas/CustomersMessage","kind":"json-schema","title":"CustomersMessage","data":{"type":"object","description":"Customer list message","properties":{"customers":{"type":"array","items":{"$ref":"#/components/schemas/CustomerMessageV2"}}},"required":["customers"]}},"components/schemas/CustomerGroupMessage":{"id":"components/schemas/CustomerGroupMessage","kind":"json-schema","title":"CustomerGroupMessage","data":{"type":"object","properties":{"id":{"type":"string","description":"Internal ID","example":"5cb6cfc92a8bc367aeec923b","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The timestamp the object was created","example":"2023-07-04T19:53:42.172Z","readOnly":true},"dateUpdated":{"type":"string","format":"date-time","description":"The timestamp the object was last updated","example":"2023-07-04T19:53:42.172Z","readOnly":true},"name":{"type":"string","description":"Name of the company","example":"Closelink GmbH"},"internalName":{"type":"string","description":"Internal name of the company for internal identification purposes","example":"CL-Hamburg"},"address":{"$ref":"#/components/schemas/AddressMessage"},"phone":{"type":"string","description":"Phone number of the company","example":"+49 40 1234567-0"},"fax":{"type":"string","description":"Fax number of the company","example":"+49 40 1234567-98"},"email":{"type":"string","description":"Email address of the company","example":"hello@closelink.com"},"invoiceMail":{"type":"string","description":"Email address for invoicing","example":"financial-department@closelink.com"},"additionalReceiver":{"type":"array","description":"A list of additional email addresses to receive emails","example":"[cc@closelink.com,bcc@closelink.com]","items":{"type":"string"}},"testCompany":{"type":"boolean","description":"Flag that indicates if the customer group is a test group","example":false},"gtcAccepted":{"type":"boolean","description":"Flag that indicates if the customer group has accepted the terms and conditions of Closelink","example":true},"invoiceVAT":{"type":"string","description":"Invoice VAT number","example":9776171},"trial":{"type":"boolean","description":"Flag that indicates if a company is on trial","example":true},"mailSettings":{"$ref":"#/components/schemas/MailSettingsMessage"},"headquarter":{"type":"string","description":"Headquarter of the company","example":"Copenhagen, Denmark"},"gtcUrl":{"type":"string","description":"URL of the terms and conditions of a customer","example":"https://www.closelink.com/terms-conditions"}},"required":["email","gtcAccepted","name","testCompany","trial"]}},"components/schemas/AssignmentMessage":{"id":"components/schemas/AssignmentMessage","kind":"json-schema","title":"AssignmentMessage","data":{"type":"object","properties":{"id":{"type":"string"},"dateCreated":{"type":"integer","format":"int64"},"dateUpdated":{"type":"integer","format":"int64"},"supplierId":{"type":"string"},"customerId":{"type":"string"},"status":{"type":"string","enum":["REQUESTED","CONFIRMED","CANCELED","DECLINED"]},"inviteMail":{"type":"string"},"inviteCompany":{"type":"string","enum":["CASTROL","SHELL","LUBMARINE","LUKOIL","EXXON","CHEVRON","GULF","OTHER"]},"dateLastUploaded":{"type":"integer","format":"int64"},"dateAdminLastUploaded":{"type":"integer","format":"int64"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"portLimitations":{"type":"array","items":{"type":"string"}},"defaultPaymentTermReference":{"type":"string"},"defaultPaymentTermReferenceDays":{"type":"integer","format":"int64"}}}},"components/schemas/AssignmentsMessage":{"id":"components/schemas/AssignmentsMessage","kind":"json-schema","title":"AssignmentsMessage","data":{"type":"object","properties":{"assignments":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentMessage"}}},"required":["assignments"]}},"components/schemas/CountryMessage":{"id":"components/schemas/CountryMessage","kind":"json-schema","title":"CountryMessage","data":{"type":"object","description":"Country entry","properties":{"id":{"type":"string","description":"Internal ID","example":"5cb6cfc92a8bc367aeec923b","readOnly":true},"name":{"type":"string","description":"The name of the country","example":"Germany"},"code":{"type":"string","description":"The code of the country","example":"DE"},"aliases":{"type":"array","description":"A list of aliases for the country","example":["Deutschland"],"items":{"type":"string"}},"region":{"type":"string","description":"The region of the country","enum":["NORTH_AMERICA","CENTRAL_AMERICA_CARIBBEAN","SOUTH_AMERICA","EUROPE","AFRICA","MIDDLE_EAST","EAST_ASIA","SOUTH_ASIA","SOUTHEAST_ASIA","OCEANIA"],"example":"EUROPE"}},"required":["code","name"]}},"components/schemas/PortMessage":{"id":"components/schemas/PortMessage","kind":"json-schema","title":"PortMessage","data":{"type":"object","description":"Port entry","properties":{"id":{"type":"string","description":"Internal ID","example":"5cb6cfc92a8bc367aeec923b","readOnly":true},"dateCreated":{"type":"string","description":"The date-time the object was created","example":"2024-04-17T07:03:37.947Z","readOnly":true},"dateUpdated":{"type":"string","description":"The date-time the object was last updated","example":"2024-04-17T07:03:37.947Z","readOnly":true},"name":{"type":"string","description":"The name of the port","example":"Hamburg"},"country":{"$ref":"#/components/schemas/CountryMessage","description":"The country of the port"},"latitude":{"type":"number","format":"double","description":"The latitude of the port","example":53.5511},"longitude":{"type":"number","format":"double","description":"The longitude of the port","example":9.9937},"locode":{"type":"string","description":"The locode of the port","example":"DEHAM"},"aliases":{"type":"array","description":"A list of aliases for the port","example":["Hamburg Süd","Hamburg Port"],"items":{"type":"string"}},"locodeAliases":{"type":"array","description":"A list of locode aliases for the port","example":["DEHAM1","DEHAM2"],"items":{"type":"string"}},"timeZoneId":{"type":"string","description":"The timezone of the port","example":"Europe/Berlin"}},"required":["country","locode","name","timeZoneId"]}},"components/schemas/DetailEnumMessage":{"id":"components/schemas/DetailEnumMessage","kind":"json-schema","title":"DetailEnumMessage","data":{"type":"object","properties":{"humanReadableValue":{"type":"string","description":"The human readable value of an enum","example":"Barge & Truck","readOnly":true},"defaultUnitSize":{"type":"integer","format":"int32","description":"The default unit size for a pack type","example":208,"readOnly":true},"applicableTypes":{"type":"array","description":"The list of types for which the property is applicable, e.g. only for LUBES","example":"LUBES","items":{"type":"string","enum":["LUBES","FUEL"]},"readOnly":true,"uniqueItems":true}}}},"components/schemas/EnumMessage":{"id":"components/schemas/EnumMessage","kind":"json-schema","title":"EnumMessage","data":{"type":"object","properties":{"supplierProductGroup":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"description":"Map of supplier product groups, keyed by enum name (e.g., 'BARGEANDTRUCK')","example":{"ADDINOL":{"humanReadableValue":"Addinol"}}},"packType":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"BOTTLE":{"humanReadableValue":"Bottle","defaultUnitSize":1,"applicableTypes":["LUBES"]}}},"productGroup":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"ANCILLARY_OIL":{"humanReadableValue":"Ancillary Oil","applicableTypes":["LUBES"]}}},"vesselTankCategory":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"AE_CIRC":{"humanReadableValue":"AE CIRC"}}},"region":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"AFRICA":{"humanReadableValue":"Africa"}}},"orderState":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"CANCELED":{"humanReadableValue":"Canceled"}}},"portDirectoryMinNotes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"DRUMS_ONLY":{"humanReadableValue":"Drums only"}}},"oilType":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"AE_CIRC":{"humanReadableValue":"AE CIRC"}}},"role":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"COMPANY_ADMIN":{"humanReadableValue":"Administrator"}}},"userType":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"GROUP_ADMIN":{"humanReadableValue":"Group Admin"}}},"status":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"ACTIVE":{"humanReadableValue":"Active"}}},"accessLevel":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"WRITE":{"humanReadableValue":"Write"}}},"supplyMode":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"BARGE":{"humanReadableValue":"Barge","applicableTypes":["LUBES"]}}},"assignmentInviteCompany":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"CASTROL":{"humanReadableValue":"Castrol"}}},"assignmentStatus":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"CANCELED":{"humanReadableValue":"Canceled"}}},"productUnit":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"BARREL":{"humanReadableValue":"Barrel","applicableTypes":["LUBES"]}}},"supplierGroupType":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"BROKER":{"humanReadableValue":"Broker"}}},"approvalRequestState":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"APPROVED":{"humanReadableValue":"Approved"}}},"companyType":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"LUBES":{"humanReadableValue":"Lubes"}}},"surchargeType":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"AGENCY_FEES":{"humanReadableValue":"Agency surcharge"}}},"paymentTermReference":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"example":{"DAYS_AFTER_DELIVERY":{"humanReadableValue":"Days after Delivery"}}},"webhookResourceType":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DetailEnumMessage"},"description":"Map of webhook resource types, keyed by enum name (e.g., 'ORDER')","example":{"APPROVAL_REQUEST":{"humanReadableValue":"Approval request"}}}}}},"components/schemas/FileMessage":{"id":"components/schemas/FileMessage","kind":"json-schema","title":"FileMessage","data":{"type":"object","properties":{"id":{"type":"string","description":"The internal ID of a product","example":"5cb6cfc92a8bc367aeec923b","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The timestamp a product was created","example":"2023-07-04T19:53:42.172Z","readOnly":true},"createdBy":{"type":["string","null"],"description":"The ID of the user the file was uploaded by","example":"5cb6cfc92a8bc367aeec923c","readOnly":true},"companyId":{"type":"string","description":"The ID of the company the file was uploaded for","example":"5cb6cfc92a8bc367aeec923d","readOnly":true},"fileName":{"type":"string","description":"The name of the file","example":"terms-and-conditions.pdf","readOnly":true}},"required":["companyId","dateCreated","fileName","id"]}},"components/schemas/MessageResponseMessageV2":{"id":"components/schemas/MessageResponseMessageV2","kind":"json-schema","title":"MessageResponseMessageV2","data":{"type":"object","description":"Messages model","properties":{"id":{"type":"string","description":"Message ID","example":"5f8f3d4e7e5f3d4e7e5f3d4e"},"dateCreated":{"type":"string","format":"date-time","description":"Date when the message was created","example":"2023-01-15T14:30:00Z"},"dateUpdated":{"type":"string","format":"date-time","description":"Date when the message was last updated","example":"2023-01-16T09:45:00Z"},"receiverId":{"type":"string","description":"ID of the message receiver","example":"5f8f3d4e7e5f3d4e7e5f3d4e"},"senderId":{"type":"string","description":"ID of the message sender","example":"5f8f3d4e7e5f3d4e7e5f3d4e"},"customerId":{"type":"string","description":"ID of the customer","example":"5f8f3d4e7e5f3d4e7e5f3d4e"},"supplierId":{"type":"string","description":"ID of the supplier","example":"5f8f3d4e7e5f3d4e7e5f3d4e"},"offerId":{"type":"string","description":"ID of the offer","example":"5f8f3d4e7e5f3d4e7e5f3d4e"},"message":{"type":"string","description":"Content of the message","example":"Thank you for your order. Your order has been confirmed."},"senderType":{"type":"string","description":"Type of the message sender","example":"USER"},"receiverType":{"type":"string","description":"Type of the message receiver","example":"SUPPLIER"},"systemMessage":{"type":"boolean","description":"Flag indicating if the message is a system message","example":false}},"required":["systemMessage"]}},"components/schemas/MessagesResponseMessage":{"id":"components/schemas/MessagesResponseMessage","kind":"json-schema","title":"MessagesResponseMessage","data":{"type":"object","description":"Messages list model","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessageResponseMessageV2"}}},"required":["messages"]}},"components/schemas/ApproverMessage":{"id":"components/schemas/ApproverMessage","kind":"json-schema","title":"ApproverMessage","data":{"type":"object","description":"Details of an approver.","properties":{"emailAddress":{"type":"string","description":"Email address of the approver.","example":"approver@example.com"}},"required":["emailAddress"]}},"components/schemas/ApprovalRequestMessage":{"id":"components/schemas/ApprovalRequestMessage","kind":"json-schema","title":"ApprovalRequestMessage","data":{"type":"object","description":"An approval request with all its details.","properties":{"id":{"type":"string","description":"Unique identifier of the approval request.","example":"5abb6605e4b05f80261fdf37"},"dateCreated":{"type":"string","description":"Date when the approval request was created.","example":"2025-01-01T00:00:00Z"},"dateUpdated":{"type":"string","description":"Date when the approval request was last updated.","example":"2025-01-02T00:00:00Z"},"createdBy":{"type":"string","description":"User who created the approval request.","example":"5abb6605e4b05f80261fdf37"},"updatedBy":{"type":"string","description":"User who last updated the approval request.","example":"5abb6605e4b05f80261fdf37"},"customerId":{"type":"string","description":"Customer ID associated with the approval request.","example":"5abb6605e4b05f80261fdf37"},"state":{"type":"string","description":"Current state of the approval request.","enum":["PENDING","APPROVED","DECLINED","WITHDRAWN","EXPIRED"],"example":"PENDING"},"offerId":{"type":"string","description":"Offer ID associated with the approval request.","example":"5abb6605e4b05f80261fdf37"},"approvers":{"type":"array","description":"List of approvers for the approval request.","items":{"$ref":"#/components/schemas/ApproverMessage"}},"controllerEmailAddress":{"type":"string","description":"Email address of the approver who responded to the approval with approval or rejection.","example":"controller@example.com"},"responseMessage":{"type":"string","description":"Response message for the approval request.","example":"Approved successfully."},"requestMessage":{"type":"string","description":"Request message for the approval request.","example":"Please approve this offer."},"dateApproved":{"type":"string","description":"Date when the approval request was approved.","example":"2025-01-03T00:00:00Z"},"dateDeclined":{"type":"string","description":"Date when the approval request was declined.","example":"2025-01-03T00:00:00Z"},"dateExpired":{"type":"string","description":"Date when the approval request expired.","example":"2025-02-01T00:00:00Z"},"dateWithdrawn":{"type":"string","description":"Date when the approval request was withdrawn.","example":"2025-01-04T00:00:00Z"},"total":{"$ref":"#/components/schemas/MoneyMessage","description":"Total amount associated with the approval request."}}}},"components/schemas/ApprovalRequestsMessage":{"id":"components/schemas/ApprovalRequestsMessage","kind":"json-schema","title":"ApprovalRequestsMessage","data":{"type":"object","description":"A collection of approval request.","properties":{"approvalRequests":{"type":"array","description":"List of approval request messages.","items":{"$ref":"#/components/schemas/ApprovalRequestMessage"}}},"required":["approvalRequests"]}},"components/schemas/ProductsListRequestMessage":{"id":"components/schemas/ProductsListRequestMessage","kind":"json-schema","title":"ProductsListRequestMessage","data":{"type":"object","properties":{"productIds":{"type":"array","description":"A list of productIds to filter","example":"5cb6cfc92a8bc367aeec923b","items":{"type":"string"},"uniqueItems":true,"writeOnly":true},"productPublicIds":{"type":"array","description":"A list of productPublicIds to filter","example":"L-3VFMZL","items":{"type":"string"},"uniqueItems":true,"writeOnly":true},"supplierProductGroups":{"type":"array","description":"A list of supplierProductGroups to filter","example":"CHEVRON","items":{"type":"string","enum":["CASTROL","SHELL","LUBMARINE","LUKOIL","EXXON","CHEVRON","GULF","SINOPEC","AEGEAN","GAZPROMNEFT","ENOC","Q8","PETRO_GULF_MARINE","PETROBRAS","ELINOIL","DEWMARINE","ORYX_MARINE","PETRONAS","INDIAN_OIL_CORP","AVIN","CEPSA","SK_MARINE_LUBRICANTS","ENI","CPC_TAIWAN","ALPET","EMARAT","LOTUS","REPSOL","NIPPON","PANOLIN","MISR","KLUEBER","NIPPON_KOYU","LANO_PRO","SUNOCO","ADDINOL","OLA","ROYAL_PURPLE","VICKERS","KEMEL","REXOIL","IDEMITSU","PERTAMINA","COSMO","DELEK","FEOSO","KITTIWAKE","MARINE_FUEL_TECHNOLOGY","SEATEC","VPS","BELGIN","GS_CALTEX","CYCLON","ETERNA","SONOL","JOMO","FUCHS","TEBOIL","OCEAN","RSC_BIO_SOLUTIONS","AVISTA","CHEMTURA","PETROL_OFISI","PREMIER_SIX_PTE","XINXIANG_RICHFUL","PARKER","MARINE_FLUID_TECHNOLOGY","CPI_FLUID_ENGINEERING","KAESER","CHEVRON_ORONITE","CMT","CLYDE_BERGEMANN","FOUNDRY_CHEM","AKSOIL","LENOL","XENOL","BITZER","HYUNDAI","ENMAR","COLTRI","YPF","INA_MAZIVA","SEA_MATE","BAUER","PRISTA_OIL","ENERGYSPRING"]},"uniqueItems":true,"writeOnly":true},"productTypes":{"type":"array","description":"A list of productTypes to filter","example":"LUBES","items":{"type":"string"},"uniqueItems":true,"writeOnly":true},"archived":{"type":"boolean","description":"A flag to filter for archived products","example":false,"writeOnly":true}}}},"components/schemas/ProductMessage":{"id":"components/schemas/ProductMessage","kind":"json-schema","title":"ProductMessage","data":{"type":"object","properties":{"id":{"type":"string","description":"The internal ID of a product","example":"5cb6cfc92a8bc367aeec923b","readOnly":true},"dateCreated":{"type":"string","description":"The timestamp a product was created","example":"2023-07-04T19:53:42.172Z","readOnly":true},"dateUpdated":{"type":"string","description":"The timestamp a product was last updated","example":"2023-07-04T19:53:42.172Z","readOnly":true},"supplierProductGroup":{"type":"string","description":"The supplier group associated with a product","example":"SHELL","readOnly":true},"publicId":{"type":"string","description":"The public ID of a product","example":"L-3VFMZL","readOnly":true},"name":{"type":"string","description":"The name of a product","example":"Aeroshell Grease 33","readOnly":true},"packTypeDefault":{"type":"string","description":"The default pack type of a product","enum":["BULK","DRUMS","IBCS","PAIL","BULK_EX_IBC","BULK_EX_DRUMS","BOTTLE","PACK","CARTON"],"example":"BULK","readOnly":true},"aliases":{"type":"array","description":"Aliases of a product, used as additional names","items":{"type":"string"},"readOnly":true},"unitDefault":{"type":"string","description":"The unit default of a product","enum":["L","KG","MT","BARREL","MWH","MMBTU","PIECE"],"example":"L","readOnly":true},"group":{"type":"string","description":"The group of a product","enum":["CYLINDER_OIL","SYSMTEM_OIL_2_STROKE","ENGINE_OIL_4_STROKE","ANCILLARY_OIL","GREASE","HFO","MDO","MGO","LNG","TEST_KIT","SAMPLE_ANALYSIS","BLEND_ON_BOARD_ADDITIVES","BASE_OIL"],"example":"GREASE","readOnly":true},"latestSuccessorProductId":{"type":"string","description":"The internal ID of the latest successor product of a given product","example":"5cb6cfc92a8bc367aeec923b","readOnly":true},"dateDeprecated":{"type":"string","description":"The timestamp a product was deprecated and should not be used anymore","example":"2023-07-04T19:53:42.172Z","readOnly":true},"type":{"type":"string","description":"The type of a product","enum":["LUBES","FUEL"],"example":"LUBES","readOnly":true},"viscosity":{"type":"integer","format":"int32","description":"The viscosity of a product","readOnly":true},"sulphurContent":{"type":"string","description":"The sulphur content of a product","enum":["HS","VLS","ULS"],"example":"HS","readOnly":true},"archived":{"type":"boolean","description":"Indicates whether a product is archived","readOnly":true}}}},"components/schemas/ProductsMessage":{"id":"components/schemas/ProductsMessage","kind":"json-schema","title":"ProductsMessage","data":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductMessage"}}}}},"components/schemas/ContractValidationErrorResponseMessage":{"id":"components/schemas/ContractValidationErrorResponseMessage","kind":"json-schema","title":"ContractValidationErrorResponseMessage","data":{"type":"object","properties":{"code":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}},"required":["code"]}},"components/schemas/ProductReferenceConflictResponse":{"id":"components/schemas/ProductReferenceConflictResponse","kind":"json-schema","title":"ProductReferenceConflictResponse","data":{"type":"object","properties":{"refProductId":{"type":"string"},"existingInverse":{"type":"string"},"supplierGroupKey":{"type":"string"},"message":{"type":"string"},"code":{"type":"string"}},"required":["code","existingInverse","message","refProductId","supplierGroupKey"]}},"components/schemas/PortCallMessage":{"id":"components/schemas/PortCallMessage","kind":"json-schema","title":"PortCallMessage","data":{"type":"object","description":"Port call entry for a vessel","properties":{"id":{"type":"string","description":"Internal ID","example":"5cb6cfc92a8bc367aeec923b","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date-time the object was created","example":"2024-04-17T07:03:37.947Z","readOnly":true},"dateUpdated":{"type":"string","format":"date-time","description":"The date-time the object was last updated","example":"2024-04-17T07:03:37.947Z","readOnly":true},"customerGroupId":{"type":"string","description":"Internal customerGroupId","example":"5cb6cfc92a8bc367aeec923b","readOnly":true},"imo":{"type":"string","description":"The imo of the vessel","example":9776171},"eta":{"type":"string","format":"date-time","description":"The estimated time of arrival","example":"2024-03-01T00:00:00.000Z"},"etd":{"type":"string","format":"date-time","description":"The estimated time of departure","example":"2024-03-05T00:00:00.000Z"},"locode":{"type":"string","description":"The locode of the port","example":"DEHAM"},"agentIds":{"type":"array","description":"A list of internal IDs of agents for a stop","example":["5cb6cfc92a8bc367aeec923b"],"items":{"type":"string"}},"source":{"type":"string","description":"Optional source system that created the port call","example":"public-api"}},"required":["eta","etd","imo","locode"]}},"components/schemas/PortCallMessages":{"id":"components/schemas/PortCallMessages","kind":"json-schema","title":"PortCallMessages","data":{"type":"object","description":"List of Port Call Messages","properties":{"portCalls":{"type":"array","items":{"$ref":"#/components/schemas/PortCallMessage"}}},"required":["portCalls"]}},"components/schemas/ValidationErrorResponseMessage":{"id":"components/schemas/ValidationErrorResponseMessage","kind":"json-schema","title":"ValidationErrorResponseMessage","data":{"type":"object","description":"Model for validation errors","properties":{"code":{"type":"string","description":"The error code of the error that was thrown","example":"VALIDATION_FAILED"},"errors":{"type":"array","description":"The list of all errors that happened at the request","items":{"$ref":"#/components/schemas/Error"}}},"required":["code"]}},"components/schemas/PortCallImportMessage":{"id":"components/schemas/PortCallImportMessage","kind":"json-schema","title":"PortCallImportMessage","data":{"type":"object","description":"Port call entry provided by an integration partner","properties":{"locode":{"type":"string","description":"The locode of the port","example":"DEHAM"},"eta":{"type":"string","description":"ETA in local port time without offset. Provide either eta or etaUtc.","example":"2026-03-30T10:00:00"},"etaUtc":{"type":"string","description":"ETA in UTC or with explicit offset. Provide either eta or etaUtc.","example":"2026-03-30T08:00:00Z"},"etd":{"type":"string","description":"ETD in local port time without offset. Provide either etd or etdUtc.","example":"2026-03-30T12:00:00"},"etdUtc":{"type":"string","description":"ETD in UTC or with explicit offset. Provide either etd or etdUtc.","example":"2026-03-30T10:00:00Z"},"source":{"type":"string","description":"Optional source system that created the port call","example":"external-planning-tool"}},"required":["locode"]}},"components/schemas/VesselPortCallImport":{"id":"components/schemas/VesselPortCallImport","kind":"json-schema","title":"VesselPortCallImport","data":{"type":"object","description":"Port call update for a single vessel","properties":{"imo":{"type":"string","description":"The IMO of the vessel","example":9776171},"portCalls":{"type":"array","description":"Port calls for the vessel. An empty list resets the vessel schedule for the current and future port calls.","items":{"$ref":"#/components/schemas/PortCallImportMessage"}}},"required":["imo","portCalls"]}},"components/schemas/PortCallImportRequest":{"id":"components/schemas/PortCallImportRequest","kind":"json-schema","title":"PortCallImportRequest","data":{"type":"object","description":"Request to replace current and future port calls by vessel","properties":{"vessels":{"type":"array","description":"List of vessel schedule updates","items":{"$ref":"#/components/schemas/VesselPortCallImport"}}},"required":["vessels"]}},"components/schemas/VesselPortCallImportResult":{"id":"components/schemas/VesselPortCallImportResult","kind":"json-schema","title":"VesselPortCallImportResult","data":{"type":"object","description":"Result summary for one vessel import entry","properties":{"imo":{"type":"string"},"action":{"type":"string","enum":["IMPORTED","RESET","SKIPPED"]},"importedCount":{"type":"integer","format":"int32"},"skippedCount":{"type":"integer","format":"int32"},"reset":{"type":"boolean"},"message":{"type":"string"}},"required":["action","imo","importedCount","reset","skippedCount"]}},"components/schemas/SkippedPortCallMessage":{"id":"components/schemas/SkippedPortCallMessage","kind":"json-schema","title":"SkippedPortCallMessage","data":{"type":"object","description":"Details for a skipped port call row","properties":{"imo":{"type":"string"},"locode":{"type":"string"},"vesselIndex":{"type":"integer","format":"int32"},"portCallIndex":{"type":"integer","format":"int32"},"code":{"type":"string"},"level":{"type":"string","enum":["INFO","ERROR"]},"message":{"type":"string"}},"required":["code","imo","level","message","vesselIndex"]}},"components/schemas/PortCallImportResponse":{"id":"components/schemas/PortCallImportResponse","kind":"json-schema","title":"PortCallImportResponse","data":{"type":"object","description":"Import summary for a port call import request","properties":{"importedCount":{"type":"integer","format":"int32"},"skippedCount":{"type":"integer","format":"int32"},"resetCount":{"type":"integer","format":"int32"},"vessels":{"type":"array","items":{"$ref":"#/components/schemas/VesselPortCallImportResult"}},"importedPortCalls":{"type":"array","items":{"$ref":"#/components/schemas/PortCallMessage"}},"skippedPortCalls":{"type":"array","items":{"$ref":"#/components/schemas/SkippedPortCallMessage"}}},"required":["importedCount","importedPortCalls","resetCount","skippedCount","skippedPortCalls","vessels"]}},"components/schemas/CompanyAccessMessage":{"id":"components/schemas/CompanyAccessMessage","kind":"json-schema","title":"CompanyAccessMessage","data":{"type":"object","properties":{"companyId":{"type":"string"},"accessLevel":{"type":"string","enum":["READ","WRITE","ADMIN"]}}}},"components/schemas/UserMessage":{"id":"components/schemas/UserMessage","kind":"json-schema","title":"UserMessage","data":{"type":"object","properties":{"id":{"type":"string"},"dateCreated":{"type":"integer","format":"int64"},"dateUpdated":{"type":"integer","format":"int64"},"email":{"type":"string"},"phone":{"type":"string"},"password":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","INVITED"]},"userType":{"type":"string","enum":["CUSTOMER","SUPPLIER","ADMIN","SYSTEM"]},"groupId":{"type":"string"},"accessLevel":{"type":"string","enum":["READ","WRITE","ADMIN"]},"companyAccesses":{"type":"array","items":{"$ref":"#/components/schemas/CompanyAccessMessage"}},"dateLastLogin":{"type":"integer","format":"int64"},"loginTimes":{"type":"integer","format":"int64"},"mailSettings":{"$ref":"#/components/schemas/MailSettingsMessage"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"ssoEnabled":{"type":"boolean"}}}},"components/schemas/PublicUserListMessage":{"id":"components/schemas/PublicUserListMessage","kind":"json-schema","title":"PublicUserListMessage","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/UserMessage"}}},"required":["content"]}},"components/schemas/VesselTankMessage":{"id":"components/schemas/VesselTankMessage","kind":"json-schema","title":"VesselTankMessage","data":{"type":"object","description":"Details about a vessel tank request","properties":{"id":{"type":"string","description":"ID of the vessel tank","example":"5fc4f3b053e79838873f72e9"},"name":{"type":"string","description":"Name of the vessel tank","example":"Tank 1"},"category":{"type":"string","description":"Category of the vessel tank","enum":["ME_CYL_HS","ME_CYL_HS_140_BN","ME_CYL_HS_100_BN","ME_CYL_HS_70_BN","ME_CYL_LS_40_BN","ME_CYL_LS","ME_CYL_ULS_17_BN","ME_CYL_ULS_25_BN","ME_CIRC_40_BN","ME_CIRC_30_BN","ME_CIRC_20_BN","ME_CIRC_LT_20_BN","ME_CIRC","AE_CIRC","AE_CIRC_20_BN","AE_CIRC_30_BN","AE_CIRC_40_BN","AE_CIRC_50_BN","STERNTUBE","RED_GEAR","ST_GEAR","BOW_THRUST","CPP","GEAR_OIL","HYDR_OIL","THERM_OIL","ME_CYL_ULS","AE_CIRC_ULS","BOB","BOB_BASE_OIL","OTHER"],"example":"ME_CYL_HS"},"customerId":{"type":"string","description":"Customer ID associated with the vessel tank","example":"5fc4f3b053e79838873f72e9"},"threshold":{"type":"integer","format":"int64","description":"Threshold of the vessel tank","example":5000},"maxVolume":{"type":"integer","format":"int64","description":"Maximum volume of the vessel tank","example":10000},"defaultProductId":{"type":"string","description":"Default product ID for the vessel tank","example":"5fc4f3b053e79838873f72e9"},"safetyReserve":{"type":"number","description":"Safety reserve of the vessel tank","example":2000}},"required":["category","customerId","name"]}},"components/schemas/VesselTanksRequestMessage":{"id":"components/schemas/VesselTanksRequestMessage","kind":"json-schema","title":"VesselTanksRequestMessage","data":{"type":"object","description":"VesselTanksRequestMessage","properties":{"vesselTanks":{"type":"array","description":"List of vessel tank requests","items":{"$ref":"#/components/schemas/VesselTankMessage"}}},"required":["vesselTanks"]}},"components/schemas/VesselTanksMessage":{"id":"components/schemas/VesselTanksMessage","kind":"json-schema","title":"VesselTanksMessage","data":{"type":"object","description":"VesselTanksMessage","properties":{"vesselTanks":{"type":"array","description":"List of vessel tanks","items":{"$ref":"#/components/schemas/VesselTankMessage"}}},"required":["vesselTanks"]}},"components/schemas/LubricationChartMessage":{"id":"components/schemas/LubricationChartMessage","kind":"json-schema","title":"LubricationChartMessage","data":{"type":"object","description":"Lubrication Chart Model","properties":{"name":{"type":"string","description":"Name of the chart","example":"Lubrication Chart A123"},"downloadUrl":{"type":"string","description":"Download url","example":"https://test.example.com/lube-chart.pdf"}}}},"components/schemas/NotificationSettingsMessage":{"id":"components/schemas/NotificationSettingsMessage","kind":"json-schema","title":"NotificationSettingsMessage","data":{"type":"object","description":"Settings for a single type of notification","properties":{"enabled":{"type":"boolean","description":"Enabled","example":true},"sendToVessel":{"type":"boolean","description":"Send notifications to the vessel","example":true},"sendToOthers":{"type":"boolean","description":"Send notifications to other recipients","example":true},"recipients":{"type":"array","description":"List of additional recipients","example":["test1@test.com","test2@test.com"],"items":{"type":"string"}}},"required":["enabled","recipients","sendToOthers","sendToVessel"]}},"components/schemas/MailNotificationSettingsMessage":{"id":"components/schemas/MailNotificationSettingsMessage","kind":"json-schema","title":"MailNotificationSettingsMessage","data":{"type":"object","description":"Email notification settings","properties":{"orderUpdateSettings":{"$ref":"#/components/schemas/NotificationSettingsMessage","description":"Notification settings for order updates"},"stockWarningSettings":{"$ref":"#/components/schemas/NotificationSettingsMessage","description":"Notification settings for stock warnings"},"safetyReserveSettings":{"$ref":"#/components/schemas/NotificationSettingsMessage","description":"Notification settings for safety reserve warnings"},"keyPortCallSettings":{"$ref":"#/components/schemas/NotificationSettingsMessage","description":"Notification settings for key port calls"}},"required":["keyPortCallSettings","orderUpdateSettings","safetyReserveSettings","stockWarningSettings"]}},"components/schemas/VesselMessage":{"id":"components/schemas/VesselMessage","kind":"json-schema","title":"VesselMessage","data":{"type":"object","description":"Vessel Model","properties":{"dateCreated":{"type":"string","format":"date-time","description":"The date the vessel was created","example":"2023-07-04T19:53:42.172Z"},"dateUpdated":{"type":"string","format":"date-time","description":"The date the vessel was last updated","example":"2023-07-04T19:53:42.172Z"},"dateActiveUpdated":{"type":"string","format":"date-time","description":"The date the active status of the vessel was last updated","example":"2023-07-04T19:53:42.172Z"},"id":{"type":"string","description":"The ID of the Vessel","example":"5fc4f3b053e79838873f72e9"},"version":{"type":"integer","format":"int64","description":"Version of the model","example":2},"customerId":{"type":"string","description":"ID of the customer this vessel belongs to","example":"61c9c86346e0fb0001fe4df6"},"name":{"type":"string","description":"Vessel name","example":"Rio Bravo"},"imo":{"type":"string","description":"The IMO ship identification number","example":923012},"email":{"type":"string","description":"Vessel email address","example":"vessel@company.com"},"invoiceVAT":{"type":"string","description":"VAT number for invoices","example":"DE123456789"},"invoiceEmailAddress":{"type":"string","description":"Invoice email address","example":"invoice@company.com"},"invoiceAddress":{"$ref":"#/components/schemas/AddressMessage","description":"Invoice address"},"postalAddress":{"$ref":"#/components/schemas/AddressMessage","description":"Postal delivery address"},"directOrderAllowed":{"type":"boolean","description":"Are direct orders allowed for this vessel","example":true},"paying":{"type":"boolean","description":"Is this a paying vessel","example":true},"active":{"type":"boolean","description":"Is this vessel active","example":true},"defaultSupplierId":{"type":"string","description":"Default supplier id","example":"61e694d1c9e77c00013dd46e"},"defaultContractId":{"type":"string","description":"Default contract id","example":"65a7f3b053e79838873f72e9"},"transactionEmailAddresses":{"type":"array","description":"Transaction email addresses","example":["vessel@company.com"],"items":{"type":"string"}},"lubricationChart":{"$ref":"#/components/schemas/LubricationChartMessage","description":"Lubrication Chart"},"services":{"type":"array","description":"Services","example":["HFO","LNG"],"items":{"type":"string"}},"types":{"type":"array","description":"Types","example":["Container","Panamax"],"items":{"type":"string"}},"mailNotificationSettings":{"$ref":"#/components/schemas/MailNotificationSettingsMessage","description":"Mail notification settings"}},"required":["active","directOrderAllowed","imo","mailNotificationSettings","name","paying","transactionEmailAddresses"]}},"components/schemas/VesselsMessage":{"id":"components/schemas/VesselsMessage","kind":"json-schema","title":"VesselsMessage","data":{"type":"object","description":"List response model for VesselMessage","properties":{"vessels":{"type":"array","description":"List of Vessels","items":{"$ref":"#/components/schemas/VesselMessage"}}},"required":["vessels"]}},"components/schemas/WebhookRequestMessage":{"id":"components/schemas/WebhookRequestMessage","kind":"json-schema","title":"WebhookRequestMessage","data":{"type":"object","description":"Model for creating or updating a webhook","properties":{"name":{"type":["string","null"],"description":"Name of the webhook","example":"Some webhook"},"groupId":{"type":["string","null"],"description":"ID of the company group","example":"507f1f77bcf86cd799439011"},"customerIds":{"type":["array","null"],"description":"CustomerIds for which the webhook should be triggered","example":"[507f1f77bcf86cd799439011, 507f1f77bcf86cd799439012]","items":{"type":"string"}},"url":{"type":["string","null"],"description":"Url that should be called when the webhook is triggered","example":"https://<your-website>/<your-webhook-endpoint>"},"resourceTypes":{"type":["array","null"],"description":"List of resources that should trigger the webhook on change","example":"[OFFER, ENQUIRY]","items":{"type":"string","enum":["DRAFT_ENQUIRY","ENQUIRY","OFFER","APPROVAL_REQUEST"]},"uniqueItems":true},"enabled":{"type":["boolean","null"],"description":"Enabled state of the webhook","example":true}},"required":["customerIds","enabled","groupId","name","resourceTypes","url"]}},"components/schemas/WebhookResponseMessage":{"id":"components/schemas/WebhookResponseMessage","kind":"json-schema","title":"WebhookResponseMessage","data":{"type":"object","description":"Response after successfully creating or updating a webhook","properties":{"id":{"type":["string","null"],"description":"Unique identifier of the webhook","example":"507f1f77bcf86cd799439011"},"secret":{"type":["string","null"],"description":"Secret for identification. Will be sent with every webhook payload.","example":"secret-key"},"name":{"type":["string","null"],"description":"Name of the webhook","example":"webhook 1"},"groupId":{"type":"string","description":"ID of the group","example":"507f1f77bcf86cd799439011"},"customerIds":{"type":["array","null"],"description":"CustomerIds for which the webhook should be triggered","example":"[507f1f77bcf86cd799439011, 507f1f77bcf86cd799439012]","items":{"type":"string"}},"url":{"type":["string","null"],"description":"Url that should be called when the webhook is triggered","example":"https://<your-website>/<your-webhook-endpoint>"},"resourceTypes":{"type":["array","null"],"description":"List of resources that should trigger the webhook on change","example":"[OFFER, ENQUIRY]","items":{"type":"string","enum":["DRAFT_ENQUIRY","ENQUIRY","OFFER","APPROVAL_REQUEST"]},"uniqueItems":true},"enabled":{"type":["boolean","null"],"description":"Enabled state of the webhook","example":true},"createdDate":{"type":["string","null"],"format":"date-time","description":"Date and time the webhook was created","example":"2024-03-07T16:37:57.079Z"},"lastModifiedDate":{"type":["string","null"],"format":"date-time","description":"Date and time the webhook was last changed","example":"2024-03-07T16:37:57.079Z"}},"required":["createdDate","customerIds","enabled","groupId","lastModifiedDate","name","resourceTypes","url"]}},"components/schemas/WebhooksResponseMessage":{"id":"components/schemas/WebhooksResponseMessage","kind":"json-schema","title":"WebhooksResponseMessage","data":{"type":"object","description":"List response model for WebhookResponseMessage","properties":{"webhooks":{"type":"array","description":"List of webhooks","items":{"$ref":"#/components/schemas/WebhookResponseMessage"}}},"required":["webhooks"]}},"components/schemas/ValueChangeObjectObject":{"id":"components/schemas/ValueChangeObjectObject","kind":"json-schema","title":"ValueChangeObjectObject","data":{"type":"object","properties":{"eventType":{},"propertyName":{"type":"string"},"from":{},"to":{}},"required":["eventType","propertyName"]}},"components/schemas/Trigger":{"id":"components/schemas/Trigger","kind":"json-schema","title":"Trigger","data":{"type":"object","properties":{"companyType":{"type":["string","null"]},"companyId":{"type":["string","null"]},"userId":{"type":["string","null"]}}}},"components/schemas/ApprovalRequestWebhookPayload":{"id":"components/schemas/ApprovalRequestWebhookPayload","kind":"json-schema","title":"ApprovalRequestWebhookPayload","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApprovalRequestMessage","description":"The main data payload of the webhook"},"action":{"type":"string","description":"The type of action that triggered this webhook","enum":["CREATED","UPDATED","DELETED"],"example":"CREATED"},"changes":{"type":"array","description":"List of changes that occurred in this webhook event","items":{"$ref":"#/components/schemas/ValueChangeObjectObject"}},"trigger":{"oneOf":[{"$ref":"#/components/schemas/Trigger"},{"type":"null"}]},"resourceType":{"type":"string","description":"The type of resource the event belongs to","enum":["DRAFT_ENQUIRY","ENQUIRY","OFFER","APPROVAL_REQUEST"],"example":"OFFER"},"createdAt":{"type":"string","format":"date-time","description":"When the event was thrown","example":"2023-01-01T12:00:00Z"},"webhookTimestamp":{"type":"string","format":"date-time","description":"When the webhook was sent","example":"2023-01-01T12:00:01Z"},"webhookId":{"type":"string","description":"Unique identifier for this webhook","example":"507f1f77bcf86cd799439011"}},"required":["action","changes","createdAt","data","resourceType","webhookId","webhookTimestamp"]}},"components/schemas/DraftEnquiryWebhookPayload":{"id":"components/schemas/DraftEnquiryWebhookPayload","kind":"json-schema","title":"DraftEnquiryWebhookPayload","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EnquiryMessage","description":"The main data payload of the webhook"},"action":{"type":"string","description":"The type of action that triggered this webhook","enum":["CREATED","UPDATED","DELETED"],"example":"CREATED"},"changes":{"type":"array","description":"List of changes that occurred in this webhook event","items":{"$ref":"#/components/schemas/ValueChangeObjectObject"}},"trigger":{"oneOf":[{"$ref":"#/components/schemas/Trigger"},{"type":"null"}]},"resourceType":{"type":"string","description":"The type of resource the event belongs to","enum":["DRAFT_ENQUIRY","ENQUIRY","OFFER","APPROVAL_REQUEST"],"example":"OFFER"},"createdAt":{"type":"string","format":"date-time","description":"When the event was thrown","example":"2023-01-01T12:00:00Z"},"webhookTimestamp":{"type":"string","format":"date-time","description":"When the webhook was sent","example":"2023-01-01T12:00:01Z"},"webhookId":{"type":"string","description":"Unique identifier for this webhook","example":"507f1f77bcf86cd799439011"}},"required":["action","changes","createdAt","data","resourceType","webhookId","webhookTimestamp"]}},"components/schemas/EnquiryWebhookPayload":{"id":"components/schemas/EnquiryWebhookPayload","kind":"json-schema","title":"EnquiryWebhookPayload","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EnquiryMessage","description":"The main data payload of the webhook"},"action":{"type":"string","description":"The type of action that triggered this webhook","enum":["CREATED","UPDATED","DELETED"],"example":"CREATED"},"changes":{"type":"array","description":"List of changes that occurred in this webhook event","items":{"$ref":"#/components/schemas/ValueChangeObjectObject"}},"trigger":{"oneOf":[{"$ref":"#/components/schemas/Trigger"},{"type":"null"}]},"resourceType":{"type":"string","description":"The type of resource the event belongs to","enum":["DRAFT_ENQUIRY","ENQUIRY","OFFER","APPROVAL_REQUEST"],"example":"OFFER"},"createdAt":{"type":"string","format":"date-time","description":"When the event was thrown","example":"2023-01-01T12:00:00Z"},"webhookTimestamp":{"type":"string","format":"date-time","description":"When the webhook was sent","example":"2023-01-01T12:00:01Z"},"webhookId":{"type":"string","description":"Unique identifier for this webhook","example":"507f1f77bcf86cd799439011"}},"required":["action","changes","createdAt","data","resourceType","webhookId","webhookTimestamp"]}},"components/schemas/OfferWebhookPayload":{"id":"components/schemas/OfferWebhookPayload","kind":"json-schema","title":"OfferWebhookPayload","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OfferMessage","description":"The main data payload of the webhook"},"action":{"type":"string","description":"The type of action that triggered this webhook","enum":["CREATED","UPDATED","DELETED"],"example":"CREATED"},"changes":{"type":"array","description":"List of changes that occurred in this webhook event","items":{"$ref":"#/components/schemas/ValueChangeObjectObject"}},"trigger":{"oneOf":[{"$ref":"#/components/schemas/Trigger"},{"type":"null"}]},"resourceType":{"type":"string","description":"The type of resource the event belongs to","enum":["DRAFT_ENQUIRY","ENQUIRY","OFFER","APPROVAL_REQUEST"],"example":"OFFER"},"createdAt":{"type":"string","format":"date-time","description":"When the event was thrown","example":"2023-01-01T12:00:00Z"},"webhookTimestamp":{"type":"string","format":"date-time","description":"When the webhook was sent","example":"2023-01-01T12:00:01Z"},"webhookId":{"type":"string","description":"Unique identifier for this webhook","example":"507f1f77bcf86cd799439011"}},"required":["action","changes","createdAt","data","resourceType","webhookId","webhookTimestamp"]}},"schema_36":{"kind":"json-schema","data":{"type":"string"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{},"id":"schema_37"}},"exampleStore":{},"securitySchemeStore":{"apikey":{"id":"apikey","type":"apiKey","in":"header","paramName":"ApiKey"}},"servers":[{"url":"/_mock/webhooks/webhooks","isMockServer":true,"description":"Mock server"},{"url":"https://public-api.closelink.com","description":"Production Environment"},{"url":"https://public-api-staging.closelink.com","description":"Staging Environment"}]},"options":{"schemasExpansionLevel":0,"jsonSamplesExpandLevel":0,"hideDownloadButtons":true,"hideInfoMetadata":true,"hideSidebar":true,"mockServer":{"url":"/_mock/webhooks/webhooks","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/webhooks/webhooks.json?download"},{"url":"/_bundle/webhooks/webhooks.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Closelink Webhooks API","description":"Closelink webhook reference"}},"baseSlug":"/webhooks/webhooks","routesMapping":{}}