{"info":{"_postman_id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","name":"Design Offices Partners API","description":"<html><head></head><body><p>This API provides endpoints for certain administrative operations against the Design Offices Booking System.</p>\n<p>For now it allows the following operations:</p>\n<ul>\n<li><p>Reading contract details</p>\n</li>\n<li><p>Adding people to a contract</p>\n</li>\n<li><p>Updating permissions of people in a contract</p>\n</li>\n<li><p>Removing people from a contract</p>\n</li>\n</ul>\n<h2 id=\"environment\">Environment</h2>\n<p>The Design Offices Partner API is available in 2 Environments:</p>\n<ul>\n<li><p>Testing: <a href=\"https://design-offices-ops-api-preview.azurewebsites.net\">https://design-offices-ops-api-preview.azurewebsites.net</a></p>\n</li>\n<li><p>Production: <a href=\"https://design-offices-ops-api.azurewebsites.net\">https://design-offices-ops-api.azurewebsites.net</a></p>\n</li>\n</ul>\n<p>Make sure to replace the variable <code>design_offices_api</code> by the desired environment.</p>\n<p>Make dure to replace the variable <code>api_key</code> by a valid API Key.</p>\n<p><em>Info:</em> API Keys are environment specific. Testing Keys will not work in production and vice versa</p>\n<h2 id=\"authentication\">Authentication</h2>\n<p>Every request must be sent with a valid API Key in the request header:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"headers\": {\n        \"Authorization\": \"Bearer &lt;API_KEY&gt;\"\n    }\n}\n\n</code></pre>\n<p>Make sure the API Key is equipped with the required permissions.</p>\n<h2 id=\"possible-errors\">Possible Errors:</h2>\n<p>The API might yield certain errors:</p>\n<h3 id=\"no-api-key-provided\">No API Key provided:</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"eid\": \"1fe73027-0b6a-424f-af70-8f779b788e27\",\n    \"code\": \"AM005\",\n    \"status\": 401,\n    \"message\": \"AM005: No API Key Found\",\n    \"details\": {}\n}\n\n</code></pre>\n<h3 id=\"invalid-api-key-provided\">Invalid API Key provided:</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"eid\": \"a4c0ea0a-1b80-453c-b0d4-e8eb45144350\",\n    \"code\": \"AM006\",\n    \"status\": 401,\n    \"message\": \"AM006: API Key Invalid\",\n    \"details\": {}\n}\n\n</code></pre>\n<h3 id=\"insufficient-permission-of-api-key\">Insufficient Permission of API Key:</h3>\n<p><em>Info:</em> The API Key is valid but it is not allowed to perform the operation.</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"eid\": \"80771969-d754-4f68-b2c8-f71463b1ef2a\",\n    \"code\": \"AM007\",\n    \"status\": 401,\n    \"message\": \"AM007: Insufficient Partner Permissions\",\n    \"details\": {}\n}\n\n</code></pre>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15222840","collectionId":"35e1aa87-3208-4cdf-907d-2d6b070012dd","publishedId":"2sA3dsmYwV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"ffcf8a"},"publishDate":"2024-06-27T08:22:20.000Z"},"item":[{"name":"Contracts","item":[{"name":"Contract Customers","id":"1f8c377a-d971-498f-8124-0edf35208b80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://design-offices-ops-api-preview.azurewebsites.net/api/v2/partners/contracts/:contractId/customers","description":"<h3 id=\"get-apiv2partnerscontractscontractidcustomers\">GET /api/v2/partners/contracts/:contractId/customers</h3>\n<p>This endpoint retrieves the list of customers associated with a specific contract.</p>\n<h4 id=\"request\">Request</h4>\n<p>No request body is required for this endpoint.</p>\n<ul>\n<li><code>:contractId</code> (path parameter) - The ID of the contract for which the customers are to be retrieved.</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<p>The response will be a JSON array containing objects with the following properties:</p>\n<ul>\n<li><p><code>permissions</code> (array) - An array of permissions associated with the customer.</p>\n</li>\n<li><p><code>id</code> - The ID of the customer.</p>\n</li>\n<li><p><code>contract</code> (object) - Details of the contract associated with the customer, including <code>createdAt</code>, <code>id</code>, <code>startDate</code>, <code>endDate</code>, and <code>earliestEndDate</code>.</p>\n</li>\n<li><p><code>customer</code> (object) - Details of the customer, including <code>id</code>, <code>firstname</code>, <code>lastname</code>, and <code>email</code>.</p>\n</li>\n</ul>\n<p>Example response:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"permissions\": [\"\"],\n    \"contract\": {\n      \"createdAt\": \"\",\n      \"id\": 0,\n      \"startDate\": \"\",\n      \"endDate\": \"\",\n      \"earliestEndDate\": \"\"\n    },\n    \"customer\": {\n      \"id\": 0,\n      \"firstname\": \"\",\n      \"lastname\": \"\",\n      \"email\": \"\",\n    }\n  }\n]\n\n</code></pre>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","name":"Design Offices Partners API","type":"collection"}},"urlObject":{"path":["api","v2","partners","contracts",":contractId","customers"],"host":["https://design-offices-ops-api-preview.azurewebsites.net"],"query":[],"variable":[{"description":{"content":"<p>The ID of the contract</p>\n","type":"text/plain"},"type":"any","value":"123","key":"contractId"}]}},"response":[{"id":"8547acdd-4bfb-45b8-bea9-d491ef192720","name":"Get Contract Customers","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://design-offices-ops-api-preview.azurewebsites.net/api/v2/partners/contracts/:contractId/customers","host":["https://design-offices-ops-api-preview.azurewebsites.net"],"path":["api","v2","partners","contracts",":contractId","customers"],"variable":[{"key":"contractId","value":"123","description":"The ID of the contract"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"permissions\": [\n            \"booking:all\",\n            \"contract:all\",\n            \"invoice:all\",\n            \"kiosk:all\"\n        ],\n        \"contract\": {\n            \"id\": 123,\n            \"startDate\": \"2022-12-31T23:00:00.000Z\",\n            \"endDate\": \"2099-12-31T00:00:00.000Z\",\n            \"earliestEndDate\": \"2024-08-30T22:00:00.000Z\"\n        },\n        \"customer\": {\n            \"id\": 1,\n            \"firstname\": \"Max\",\n            \"lastname\": \"Muster\",\n            \"email\": \"max.muster@designoffices.de\"\n        }\n    },\n        {\n        \"permissions\": [\n            \"booking:all\",\n            \"contract:all\",\n            \"invoice:all\"\n        ],\n        \"contract\": {\n            \"id\": 123,\n            \"startDate\": \"2022-12-31T23:00:00.000Z\",\n            \"endDate\": \"2099-12-31T00:00:00.000Z\",\n            \"earliestEndDate\": \"2024-08-30T22:00:00.000Z\"\n        },\n        \"customer\": {\n            \"id\": 2,\n            \"firstname\": \"Erika\",\n            \"lastname\": \"Muster\",\n            \"email\": \"erika.muster@designoffices.de\"\n        }\n    }\n]"}],"_postman_id":"1f8c377a-d971-498f-8124-0edf35208b80"},{"name":"Contract Customer","id":"66be4df2-8437-4708-b7c1-72080a97eb85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"permissions\": [\n        \"booking:all\"\n    ],\n    \"email\": \"hans.dampf@designoffices.de\",\n    \"firstname\": \"Hans\",\n    \"lastname\": \"Dampf\"\n}","options":{"raw":{"language":"json"}}},"url":"https://design-offices-ops-api-preview.azurewebsites.net/api/v2/partners/contracts/:contractId/customers","description":"<h3 id=\"post-apiv2partnerscontractsidcustomers\">POST /api/v2/partners/contracts/:id/customers</h3>\n<p>This endpoint is used to add customers to a specific contract.</p>\n<h4 id=\"information-on-permissions\">Information on \"Permissions\":</h4>\n<p>Currently the following customer permissions are available:</p>\n<ul>\n<li><p><code>booking:all</code> - The customer is allowed to do bookings on behalf of the company (will be charged by the end of the month)</p>\n</li>\n<li><p><code>kiosk:all</code> - The customer is allowed to use the kiosk (mobile app) and purchase items</p>\n</li>\n<li><p><code>invoice:all</code> - The customer is allowed to inspect invoices of the contract in the Admin Dashboard at designoffices.de</p>\n</li>\n<li><p><code>contract:all</code> - The customer is allowed to administer (Add, Update, Remove) the customers associated with the contract in the Admin Dashboard at designoffices.de</p>\n</li>\n<li><p><code>quota:all</code> - The customer is allowed to use potential booking quotas associated with the contract.</p>\n</li>\n</ul>\n<h4 id=\"request\">Request</h4>\n<ul>\n<li><p><code>permissions</code> (array of strings, optional): Specifies the permissions for the customer.</p>\n</li>\n<li><p><code>email</code> (string, optional): The email address of the customer.</p>\n</li>\n<li><p><code>firstname</code> (string, optional): The first name of the customer.</p>\n</li>\n<li><p><code>lastname</code> (string, optional): The last name of the customer.</p>\n</li>\n</ul>\n<p><strong>Path Parameters:</strong></p>\n<ul>\n<li><code>:contractId</code> (path parameter) - The ID of the contract the customer should be added to.</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<p>The response will be a JSON object containing the following properties:</p>\n<ul>\n<li><p><code>permissions</code> (array) - An array of permissions associated with the customer.</p>\n</li>\n<li><p><code>customer</code> (object) - Details of the customer, including <code>id</code>, <code>firstname</code>, <code>lastname</code>, and <code>email</code>.</p>\n</li>\n</ul>\n<p>Example response:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"permissions\": [\n        \"booking:all\"\n    ],\n    \"customer\": {\n        \"id\": 747,\n        \"firstname\": \"User\",\n        \"lastname\": \"Name\",\n        \"email\": \"user.name@designoffices.de\"\n    }\n}\n\n</code></pre>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","name":"Design Offices Partners API","type":"collection"}},"urlObject":{"path":["api","v2","partners","contracts",":contractId","customers"],"host":["https://design-offices-ops-api-preview.azurewebsites.net"],"query":[],"variable":[{"description":{"content":"<p>The ID of the contract the customer should be added to</p>\n","type":"text/plain"},"type":"any","value":"123","key":"contractId"}]}},"response":[{"id":"f9f3d824-d05d-4a3e-898f-cbba74e1b145","name":"Add Contract Customer","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"permissions\": [\n        \"booking:all\"\n    ],\n    \"email\": \"john.doe@designoffices.de\",\n    \"firstname\": \"John\",\n    \"lastname\": \"Doe\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://design-offices-ops-api-preview.azurewebsites.net/api/v2/partners/contracts/:contractId/customers","host":["https://design-offices-ops-api-preview.azurewebsites.net"],"path":["api","v2","partners","contracts",":contractId","customers"],"variable":[{"key":"contractId","value":"123","description":"The ID of the contract the customer should be added to"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"125"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 27 Jun 2024 08:27:08 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"7d-HcOSw4hYgwHzXU7qtUYHbDWzooM\""},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"x-mt-build","value":"1859"},{"key":"x-mt-version","value":"preview - 2.2.11"},{"key":"x-mt-trace","value":"f388d328499ba67dc66de4080753dfa0"}],"cookie":[],"responseTime":null,"body":"{\n    \"permissions\": [\n        \"booking:all\"\n    ],\n    \"customer\": {\n        \"id\": 839,\n        \"firstname\": \"John\",\n        \"lastname\": \"Doe\",\n        \"email\": \"john.doe@designoffices.de\"\n    }\n}"}],"_postman_id":"66be4df2-8437-4708-b7c1-72080a97eb85"},{"name":"Contract Customer","id":"60154328-8e60-4fa2-a9d7-b64498068e1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"permissions\": [\"booking:all\", \"invoice:all\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://design-offices-ops-api-preview.azurewebsites.net/api/v2/partners/contracts/:contractId/customers/:customerId","description":"<h3 id=\"update-contract-customer-permissions\">Update Contract Customer Permissions</h3>\n<p>This endpoint allows you to update the permissions for a specific customer within a contract.</p>\n<h4 id=\"request\">Request</h4>\n<ul>\n<li><code>permissions</code> (array of strings): Specifies the updated permissions for the customer.</li>\n</ul>\n<p><em>Note:</em> Existing permissions will not be extended. The customer will always end up with the exact permission provided in this request</p>\n<p><strong>Path Parameters:</strong></p>\n<ul>\n<li><p><code>:contractId</code> (path parameter) - The ID of the contract that includes the customer that should be updated</p>\n</li>\n<li><p><code>:customerId</code> (path parameter) - The ID of the customer that should be updated</p>\n</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<p>The response will be a JSON object containing the following properties:</p>\n<ul>\n<li><p><code>permissions</code> (array) - An array of permissions associated with the customer.</p>\n</li>\n<li><p><code>customer</code> (object) - Details of the customer, including <code>id</code>, <code>firstname</code>, <code>lastname</code>, and <code>email</code>.</p>\n</li>\n</ul>\n<p>Example response:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"permissions\": [\n        \"invoice:all\"\n    ],\n        \"contract\": {\n        \"id\": 703,\n        \"startDate\": \"2022-12-31T23:00:00.000Z\",\n        \"endDate\": \"2024-08-31T22:00:00.000Z\",\n        \"earliestEndDate\": \"2024-08-31T22:00:00.000Z\"\n    },\n    \"customer\": {\n        \"id\": 747,\n        \"firstname\": \"User\",\n        \"lastname\": \"Name\",\n        \"email\": \"user.name@designoffices.de\"\n    }\n}\n\n</code></pre>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","name":"Design Offices Partners API","type":"collection"}},"urlObject":{"path":["api","v2","partners","contracts",":contractId","customers",":customerId"],"host":["https://design-offices-ops-api-preview.azurewebsites.net"],"query":[],"variable":[{"description":{"content":"<p>The ID of the contract that includes the customer that should be updated</p>\n","type":"text/plain"},"type":"any","value":"123","key":"contractId"},{"description":{"content":"<p>The ID of the customer that should be updated</p>\n","type":"text/plain"},"type":"any","value":"839","key":"customerId"}]}},"response":[{"id":"b9a6edf6-bbed-49dd-ab80-1ae7b0dd7815","name":"Update Contract Customer","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"permissions\": [\"booking:all\", \"invoice:all\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://design-offices-ops-api-preview.azurewebsites.net/api/v2/partners/contracts/:contractId/customers/:customerId","host":["https://design-offices-ops-api-preview.azurewebsites.net"],"path":["api","v2","partners","contracts",":contractId","customers",":customerId"],"variable":[{"key":"contractId","value":"123","description":"The ID of the contract that includes the customer that should be updated"},{"key":"customerId","value":"839","description":"The ID of the customer that should be updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"282"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 27 Jun 2024 08:27:55 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"11a-N7UwGjhBe+Ag8gqBgn0lHzGc3ko\""},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"x-mt-build","value":"1859"},{"key":"x-mt-version","value":"preview - 2.2.11"},{"key":"x-mt-trace","value":"b08b1f7ba81a42e4f34d2bf0f0e74fc0"}],"cookie":[],"responseTime":null,"body":"{\n    \"permissions\": [\n        \"booking:all\",\n        \"invoice:all\"\n    ],\n    \"contract\": {\n        \"id\": 123,\n        \"startDate\": \"2022-12-31T23:00:00.000Z\",\n        \"endDate\": \"2099-12-31T00:00:00.000Z\",\n        \"earliestEndDate\": \"2024-08-30T22:00:00.000Z\"\n    },\n    \"customer\": {\n        \"id\": 839,\n        \"firstname\": \"John\",\n        \"lastname\": \"Doe\",\n        \"email\": \"john.doe@designoffices.de\"\n    }\n}"}],"_postman_id":"60154328-8e60-4fa2-a9d7-b64498068e1b"},{"name":"Contract Customer","id":"b1b58ccb-6f2e-4592-b289-7ed95cabdf89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://design-offices-ops-api-preview.azurewebsites.net/api/v2/partners/contracts/:contractId/customers/:customerId","description":"<h3 id=\"remove-contract-customer\">Remove Contract Customer</h3>\n<p>This endpoint is used to remove a customer from a specific contract.</p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>This request does not require a request body.</p>\n<p><strong>Path Parameters:</strong></p>\n<ul>\n<li><p><code>:contractId</code> (path parameter) - The ID of the contract the customer should be removed from.</p>\n</li>\n<li><p><code>:customerId</code> (path parameter) - The ID of the cusotmer that should be removed from the contract.</p>\n</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<p>The response will be a JSON object containing the following properties:</p>\n<ul>\n<li><code>count</code> (number) - Indicates how many customers were removed.</li>\n</ul>\n<p>Example response:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"count\": 1\n}\n\n</code></pre>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","name":"Design Offices Partners API","type":"collection"}},"urlObject":{"path":["api","v2","partners","contracts",":contractId","customers",":customerId"],"host":["https://design-offices-ops-api-preview.azurewebsites.net"],"query":[],"variable":[{"description":{"content":"<p>The ID of the contract the customer should be removed from</p>\n","type":"text/plain"},"type":"any","value":"123","key":"contractId"},{"description":{"content":"<p>The ID of the customer that should be removed</p>\n","type":"text/plain"},"type":"any","value":"839","key":"customerId"}]}},"response":[{"id":"455735c0-818b-4090-815d-9ccf0211e6da","name":"Remove Contract Customer","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://design-offices-ops-api-preview.azurewebsites.net/api/v2/partners/contracts/:contractId/customers/:customerId","host":["https://design-offices-ops-api-preview.azurewebsites.net"],"path":["api","v2","partners","contracts",":contractId","customers",":customerId"],"variable":[{"key":"contractId","value":"123","description":"The ID of the contract the customer should be removed from"},{"key":"customerId","value":"839","description":"The ID of the customer that should be removed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"11"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 27 Jun 2024 08:28:33 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"b-qA97yBec1rrOyf2eVsYdWwFPOso\""},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"x-mt-build","value":"1859"},{"key":"x-mt-version","value":"preview - 2.2.11"},{"key":"x-mt-trace","value":"ff4373b326a86c7dd9a7dba4d26c8462"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 1\n}"}],"_postman_id":"b1b58ccb-6f2e-4592-b289-7ed95cabdf89"},{"name":"Contract Orders","id":"04a588ed-3ffa-434c-bb2c-590fc3d841e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://design-offices-ops-api-preview.azurewebsites.net/api/v2/partners/contracts/:contractId/orders?limit=10&skip=0","description":"<h3 id=\"get-apiv2partnerscontractscontractidorders\">GET /api/v2/partners/contracts/:contractId/orders</h3>\n<p>This endpoint retrieves the list of orders associated with a specific contract.</p>\n<h4 id=\"request\">Request</h4>\n<p>No request body is required for this endpoint.</p>\n<ul>\n<li><code>:contractId</code> (path parameter) - The ID of the contract for which the customers are to be retrieved.</li>\n</ul>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<p>The list can be configured by using the following query paramteres (all parameters are optional):</p>\n<ul>\n<li><p><code>limit</code> (number) - sets the maximum amount of entries yielded by this endpoint</p>\n</li>\n<li><p><code>skip</code> (number) - sets the amount of entries that should be skipped (can be used for pagination in combination with <code>limit</code>)</p>\n</li>\n<li><p><code>createdAt</code> (string - ISO Date) filter the list for entries with a certain <code>createdAt</code><br />  <em>Note:</em> This filter can be used with the follwoing query functions:</p>\n<ul>\n<li><p>date_lte() - createdAt must be lower than or equal the provided date.<br />  Eg: <code>date_lte()2024-07-19T23:59:99.000Z</code> yields all entries with createdAt <strong>before</strong> <code>2024-07-19T23:59:99.000Z</code></p>\n</li>\n<li><p>date_gte() - createdAt must be greater than or equal the provided date.<br />  Eg: <code>date_gte()2024-07-19T23:59:99.000Z</code> yields all entries with createdAt <strong>after</strong> <code>2024-07-19T23:59:99.000Z</code></p>\n</li>\n<li><p>date_between() - createdAt must be between the two provided dates<br />  Eg: <code>date_between()2024-07-19T00:00:00.000Z__2024-07-19T23:59:99.000Z</code> yields all entries with createdAt <strong>between</strong> <code>2024-07-19T00:00:00.000Z</code> and <code>2024-07-19T23:59:99.000Z</code><strong>Important:</strong> The two dates must be seperated by two underscores: <code>date_between()${from}__${to}</code></p>\n</li>\n</ul>\n</li>\n<li><p><code>bookingStart</code> (string - ISO Date) filter the list for entries that contain a booking with a certain start date<br />  <em>Note:</em> This filter can be used with the follwoing query functions:</p>\n<ul>\n<li><p>date_lte() - createdAt must be lower than or equal the provided date.<br />  Eg: <code>date_lte()2024-07-19T23:59:99.000Z</code> yields all entries with a booking that started <strong>before</strong> <code>2024-07-19T23:59:99.000Z</code></p>\n</li>\n<li><p>date_gte() - createdAt must be greater than or equal the provided date.<br />  Eg: <code>date_gte()2024-07-19T23:59:99.000Z</code> yields all entries with a booking that started <strong>after</strong> <code>2024-07-19T23:59:99.000Z</code></p>\n</li>\n<li><p>date_between() - createdAt must be between the two provided dates<br />  Eg: <code>date_between()2024-07-19T00:00:00.000Z__2024-07-19T23:59:99.000Z</code> yields all entries with a booking that started <strong>between</strong> <code>2024-07-19T00:00:00.000Z</code> and <code>2024-07-19T23:59:99.000Z</code><strong>Important:</strong> The two dates must be seperated by two underscores: <code>date_between()${from}__${to}</code></p>\n</li>\n</ul>\n</li>\n<li><p><code>customer.email</code> (string) - filter the list for entries with a certain customer email</p>\n</li>\n<li><p><code>customer.firstname</code> (string) - filter the list for entries with a certain customer firstname</p>\n</li>\n<li><p><code>customer.lastname</code> (string) - filter the list for entries with a certain customer lastname</p>\n</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<p>The response will be a JSON array containing objects with the following properties:</p>\n<ul>\n<li><p><code>id</code> - The ID of the customer.</p>\n</li>\n<li><p><code>createdAt</code> - The creation date of the order</p>\n</li>\n<li><p><code>status</code> - The order status</p>\n</li>\n<li><p><code>salesorderNumber</code> - The Order Number</p>\n</li>\n<li><p><code>total</code> - The total gross amount that was charged for the order</p>\n</li>\n<li><p><code>totalnet</code> - The total net amount that was charged for the order</p>\n</li>\n<li><p><code>discount</code> - Potential discount in percent</p>\n</li>\n<li><p><code>orderReference</code> - The optional order reference - might be a string or null</p>\n</li>\n<li><p><code>contactEmail</code> - An optional order contact email - might be a string or null</p>\n</li>\n<li><p><code>customer</code> (object) - Details of the customer that placed the order, including <code>id</code>, <code>firstname</code>, <code>lastname</code>, and <code>email</code>.</p>\n</li>\n<li><p><code>lineItems</code> (array) - A list of all purchased products within this order, includes one or more line items.</p>\n</li>\n</ul>\n<p>Example response:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n    {\n        \"id\": 1,\n        \"createdAt\": \"\",\n        \"status\": \"\",\n        \"salesorderNumber\": \"\",\n        \"total\": 1,\n        \"totalnet\": 1,\n        \"discount\": 1,\n        \"orderReference\": \"\",\n        \"customer\": {\n            \"id\": 1,\n            \"firstname\": \"\",\n            \"lastname\": \"\",\n            \"email\": \"\"\n        },\n        \"contactEmail\": null,\n        \"lineItems\": [\n            {\n                \"grossPrice\": 1,\n                \"unit\": \"\",\n                \"quantity\": 1,\n                \"pax\": 2,\n                \"discountCode\": null,\n                \"startDate\": \"\",\n                \"endDate\": \"\",\n                \"product\": {\n                    \"name\": \"\",\n                    \"site\": {\n                        \"name\": \"\",\n                        \"city\": \"\"\n                    }\n                },\n                \"totalPrice\": 1,\n                \"subLineItems\": []\n            }\n        ]\n    }\n]\n\n</code></pre>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","name":"Design Offices Partners API","type":"collection"}},"urlObject":{"path":["api","v2","partners","contracts",":contractId","orders"],"host":["https://design-offices-ops-api-preview.azurewebsites.net"],"query":[{"key":"limit","value":"10"},{"key":"skip","value":"0"},{"disabled":true,"key":"createdAt","value":null},{"disabled":true,"key":"bookingStart","value":null},{"disabled":true,"key":"customer.email","value":null},{"disabled":true,"key":"customer.firstname","value":null},{"disabled":true,"key":"customer.lastname","value":null}],"variable":[{"description":{"content":"<p>The ID of the contract</p>\n","type":"text/plain"},"type":"any","value":"123","key":"contractId"}]}},"response":[{"id":"86f24dd2-7758-44c5-bfd9-cfc277852016","name":"Get Contract Orders","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://design-offices-ops-api-preview.azurewebsites.net/api/v2/partners/contracts/:contractId/orders?createdAt=date_between()2024-07-05T14:48:00.000Z__2024-07-20T14:48:00.000Z&bookingStart=date_between()2024-08-05T14:48:00.000Z__2024-08-25T14:48:00.000Z&limit=10&customer.email=test.user@designoffices.de","host":["https://design-offices-ops-api-preview.azurewebsites.net"],"path":["api","v2","partners","contracts",":contractId","orders"],"query":[{"key":"createdAt","value":"date_between()2024-07-05T14:48:00.000Z__2024-07-20T14:48:00.000Z"},{"key":"bookingStart","value":"date_between()2024-08-05T14:48:00.000Z__2024-08-25T14:48:00.000Z"},{"key":"limit","value":"10"},{"key":"customer.email","value":"test.user@designoffices.de"}],"variable":[{"key":"contractId","value":"123","description":"The ID of the contract"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-mt-build","value":"undefined"},{"key":"x-mt-version","value":"local - 2.2.14"},{"key":"x-mt-trace","value":"542781f08d4201b2953e8936f76d9188"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"695"},{"key":"ETag","value":"W/\"2b7-SA0UoDff2j3OM+ud26MwqWEP9pE\""},{"key":"Date","value":"Thu, 15 Aug 2024 11:24:45 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"id\": 955,\n        \"createdAt\": \"2024-07-19T11:14:08.838Z\",\n        \"status\": \"fullfilled\",\n        \"salesorderNumber\": \"ORD-79557-X9C2L8\",\n        \"total\": 44.5,\n        \"totalnet\": 37.395,\n        \"discount\": 50,\n        \"orderReference\": \"Test\",\n        \"customer\": {\n            \"id\": 5,\n            \"firstname\": \"Test\",\n            \"lastname\": \"User\",\n            \"email\": \"test.user@designoffices.de\"\n        },\n        \"contactEmail\": null,\n        \"lineItems\": [\n            {\n                \"grossPrice\": 44.5,\n                \"unit\": \"Stunde\",\n                \"quantity\": 1,\n                \"pax\": 2,\n                \"discountCode\": null,\n                \"startDate\": \"2024-08-20T06:00:00.000Z\",\n                \"endDate\": \"2024-08-20T07:00:00.000Z\",\n                \"product\": {\n                    \"name\": \"Meet & Move I\",\n                    \"site\": {\n                        \"name\": \"Nürnberg City\",\n                        \"city\": \"Nürnberg\"\n                    }\n                },\n                \"totalPrice\": 37.395,\n                \"subLineItems\": []\n            }\n        ]\n    }\n]"}],"_postman_id":"04a588ed-3ffa-434c-bb2c-590fc3d841e9"}],"id":"91184f4f-2d94-43af-a58c-8190e74b79f0","_postman_id":"91184f4f-2d94-43af-a58c-8190e74b79f0","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","id":"35e1aa87-3208-4cdf-907d-2d6b070012dd","name":"Design Offices Partners API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"227728b5-a466-4cbd-a221-e8dbd5c1001e","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"a6ecc6c8-734a-4047-bcce-a3349ab4f141","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"design_offices_api","value":"https://design-offices-ops-api-preview.azurewebsites.net","type":"string"},{"key":"api_key","value":"","type":"string"}]}