{"items":[{"type":"link","label":"PTV OptiFlow Order Book API","link":"/apis/order-book/order-book-api","routeSlug":"/apis/order-book/order-book-api","content":{"contentType":"overview","meta":{"name":"PTV OptiFlow Order Book API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"order-book-api.json","url":"/_bundle/apis/order-book/order-book-api.json?download"},{"kind":"download","label":"order-book-api.yaml","url":"/_bundle/apis/order-book/order-book-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://servicedesk.conundra.eu","url":"https://servicedesk.conundra.eu"}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"PTV OptiFlow Order Book API (1.12.5)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Order Book provides ready-to-run domain-specific logistic data governance for your route optimization."}],"sectionId":"/apis/order-book/order-book-api"}],"sectionId":"/apis/order-book/order-book-api"}]}]}},{"type":"separator","label":"Health","content":null},{"type":"group","label":"Health check","link":"/apis/order-book/order-book-api/health","routeSlug":"/apis/order-book/order-book-api/health","items":[{"label":"Ping","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/health/ping","routeSlug":"/apis/order-book/order-book-api/health/ping","metadata":{"seo":{"title":"Ping","description":"The ping-endpoint can be used for validating a connection with the application. It will authenticate the caller and respond pong if everything is set-up correctly."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ping","name":"Ping","isWebhook":false,"pointer":"/paths/~1ping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ping","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-endpoint can be used for validating a connection with the application. It will authenticate the caller and respond "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pong"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if everything is set-up correctly."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ping","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/ping","href":"health/ping","openApiOperationId":"ping","summary":"Ping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"pong","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_47"}},"schemaId":"schema_47"}],"pointer":"/paths/~1ping/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_47","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_47"}}}],"examples":[]}]}]}]},"httpPath":"/ping"}],"content":{"contentType":"group","meta":{"name":"health"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health check","showPageActions":true},{"nodeType":"markdoc","content":"Miscellaneous endpoints for general API functionality"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ping","summary":"Ping","prefix":{"name":"get","color":"get"},"badges":[],"link":"/health/ping","deprecated":false}]}]}]}]}},{"type":"separator","label":"Order Management","content":null},{"type":"group","label":"Orders","link":"/apis/order-book/order-book-api/orders","routeSlug":"/apis/order-book/order-book-api/orders","items":[{"label":"Get a cursor-paged list of orders that are not part of a transport request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/orders/getorders","routeSlug":"/apis/order-book/order-book-api/orders/getorders","metadata":{"seo":{"title":"Get a cursor-paged list of orders that are not part of a transport request","description":"Retrieve a cursor-paged list of all orders across all order types that are not part of a transport request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrders","name":"Get a cursor-paged list of orders that are not part of a transport request","isWebhook":false,"pointer":"/paths/~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a cursor-paged list of orders that are not part of a transport request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a cursor-paged list of all orders across all order types that are not part of a transport request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can find out more about how to use cursors in our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.conundra.eu/developer-portal/cursor-paging/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"developer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor of the page to retrieve. Can be left blank initially to retrieve the first page. Paging through the results requires passing in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from a previous response."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_48","description":"Number of results per page."}],"pointer":"/paths/~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","schemaId":"schema_47"},{"name":"limit","in":"query","schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/orders","href":"orders/getorders","openApiOperationId":"getOrders","summary":"Get a cursor-paged list of orders that are not part of a transport request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A cursor-based paged set of orders. The set might be empty if no orders are present.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageOrders"}},"schemaId":"components/schemas/CursorPageOrders"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPageOrders","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageOrders"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/orders"}],"content":{"contentType":"group","meta":{"name":"orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for querying orders across all order types."},{"nodeType":"external-docs","url":"https://developer.conundra.eu/developer-portal/order-book/domain/#order","description":"Find out more"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orders","summary":"Get a cursor-paged list of orders that are not part of a transport request","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getorders","deprecated":false}]}]}]}]}},{"type":"group","label":"Pickup Orders","link":"/apis/order-book/order-book-api/pickups","routeSlug":"/apis/order-book/order-book-api/pickups","items":[{"label":"Get a Pickup by business id for a given TransportRequest","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/pickups/getpickupbytransportrequestidandorderid","routeSlug":"/apis/order-book/order-book-api/pickups/getpickupbytransportrequestidandorderid","metadata":{"seo":{"title":"Get a Pickup by business id for a given TransportRequest","description":"This endpoint allows you to get the information about a given pickup that is contained in a TransportRequest."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPickupByTransportRequestIdAndOrderId","name":"Get a Pickup by business id for a given TransportRequest","isWebhook":false,"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Pickup by business id for a given TransportRequest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to get the information about a given pickup that is contained in a TransportRequest."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is not possible to retrieve pickups within TransportRequests directly through the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a Pickup by business Id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The identifier of the TransportRequest within which this pickup exists.\n","required":true},{"name":"order_id","in":"path","schemaId":"schema_47","description":"The identifier of a Pickup instance","required":true}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transport-requests/{business_id}/orders/pickups/{order_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","default"],"pointer":"/transport-requests/{business_id}/orders/pickups/{order_id}","href":"pickups/getpickupbytransportrequestidandorderid","openApiOperationId":"getPickupByTransportRequestIdAndOrderId","summary":"Get a Pickup by business id for a given TransportRequest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupInTransportRequest"}},"schemaId":"components/schemas/PickupInTransportRequest","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_50"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PickupInTransportRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupInTransportRequest"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/{business_id}/orders/pickups/{order_id}"},{"label":"Upsert a Pickup by business id for a given TransportRequest","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/pickups/upsertpickupbytransportrequestidandorderid","routeSlug":"/apis/order-book/order-book-api/pickups/upsertpickupbytransportrequestidandorderid","metadata":{"seo":{"title":"Upsert a Pickup by business id for a given TransportRequest","description":"Upsert pickup information. When if-match is not specified, then no optimistic protection is applied, ie: the last update wins."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertPickupByTransportRequestIdAndOrderId","name":"Upsert a Pickup by business id for a given TransportRequest","isWebhook":false,"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a Pickup by business id for a given TransportRequest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsert pickup information. When if-match is not specified, then no optimistic protection is applied, ie: the last update wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is not possible to update pickups within TransportRequests directly through the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsert a Pickup by business Id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The identifier of the TransportRequest within which this pickup must be added/edited.\n","required":true},{"name":"order_id","in":"path","schemaId":"schema_47","description":"The identifier of a Pickup instance","required":true}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"},{"name":"Prefer","in":"header","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status codes 200 or 201 with the resource in the response body on success (representation)."},"children":[]}]}]}]}]}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pickup","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/put/requestBody/content/application~1json/examples/pickup_example"]}},"schemaId":"components/schemas/Pickup","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/put/requestBody/content/application~1json/examples/pickup_example"],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/transport-requests/{business_id}/orders/pickups/{order_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"},{"name":"Prefer","in":"header","schemaId":"schema_51"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Pickup","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/put/requestBody/content/application~1json/examples/pickup_example"]}},"responseCodes":["201","204","404","409","412","default"],"pointer":"/transport-requests/{business_id}/orders/pickups/{order_id}","href":"pickups/upsertpickupbytransportrequestidandorderid","openApiOperationId":"upsertPickupByTransportRequestIdAndOrderId","summary":"Upsert a Pickup by business id for a given TransportRequest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/Pickup","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/put/requestBody/content/application~1json/examples/pickup_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pickup","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/put/requestBody/content/application~1json/examples/pickup_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Order updated\n\nResponse body contains updated Order\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupInTransportRequest"}},"schemaId":"components/schemas/PickupInTransportRequest","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_52"},{"code":"204","description":"No Content","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_52"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","description":"Response status code indicates a request conflict with current state of the server.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PickupInTransportRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupInTransportRequest"}}},{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/{business_id}/orders/pickups/{order_id}"},{"label":"Delete a Pickup by business id for a given TransportRequest","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/pickups/deletepickupbytransportrequestidandorderid","routeSlug":"/apis/order-book/order-book-api/pickups/deletepickupbytransportrequestidandorderid","metadata":{"seo":{"title":"Delete a Pickup by business id for a given TransportRequest","description":"This endpoint allows you to delete a given pickup within a transport request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePickupByTransportRequestIdAndOrderId","name":"Delete a Pickup by business id for a given TransportRequest","isWebhook":false,"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Pickup by business id for a given TransportRequest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to delete a given pickup within a transport request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is not possible to delete pickups within TransportRequests directly through the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a Pickup by business Id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The identifier of the TransportRequest from which this pickup must be removed.\n","required":true},{"name":"order_id","in":"path","schemaId":"schema_47","description":"The identifier of a Pickup instance","required":true}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/transport-requests/{business_id}/orders/pickups/{order_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","404","412","default"],"pointer":"/transport-requests/{business_id}/orders/pickups/{order_id}","href":"pickups/deletepickupbytransportrequestidandorderid","openApiOperationId":"deletePickupByTransportRequestIdAndOrderId","summary":"Delete a Pickup by business id for a given TransportRequest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/{business_id}/orders/pickups/{order_id}"},{"label":"Get a Pickup by business Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/pickups/getpickupbyid","routeSlug":"/apis/order-book/order-book-api/pickups/getpickupbyid","metadata":{"seo":{"title":"Get a Pickup by business Id","description":"Retrieve a single Pickup order by its business id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPickupById","name":"Get a Pickup by business Id","isWebhook":false,"pointer":"/paths/~1orders~1pickups~1{business_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Pickup by business Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a single Pickup order by its business id.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1orders~1pickups~1{business_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/pickups/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","default"],"pointer":"/orders/pickups/{business_id}","href":"pickups/getpickupbyid","openApiOperationId":"getPickupById","summary":"Get a Pickup by business Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pickup"}},"schemaId":"components/schemas/Pickup"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orders~1pickups~1{business_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pickup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pickup"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/orders/pickups/{business_id}"},{"label":"Upsert a Pickup by business Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/pickups/upsertpickupbyid","routeSlug":"/apis/order-book/order-book-api/pickups/upsertpickupbyid","metadata":{"seo":{"title":"Upsert a Pickup by business Id","description":"Create or update a Pickup Order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertPickupById","name":"Upsert a Pickup by business Id","isWebhook":false,"pointer":"/paths/~1orders~1pickups~1{business_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a Pickup by business Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update a Pickup Order.\n\nThis endpoint allows you to update (default behaviour) or insert a Pickup Order. The caller is responsible for\nproviding a unique business identifier for each Order, regardless of order type. If this business identifier can't be found,\na new order will be created. If a Pickup order with the given business identifier can be found then it will be updated.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1orders~1pickups~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status codes 200 or 201 with the resource in the response body on success (representation)."},"children":[]}]}]}]}]}],"pointer":"/paths/~1orders~1pickups~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pickup","exampleIds":["paths/~1orders~1pickups~1{business_id}/put/requestBody/content/application~1json/examples/pickup_example"]}},"schemaId":"components/schemas/Pickup","exampleIds":["paths/~1orders~1pickups~1{business_id}/put/requestBody/content/application~1json/examples/pickup_example"],"pointer":"/paths/~1orders~1pickups~1{business_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/orders/pickups/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","schemaId":"schema_51"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Pickup","exampleIds":["paths/~1orders~1pickups~1{business_id}/put/requestBody/content/application~1json/examples/pickup_example"]}},"responseCodes":["201","204","404","409","412","default"],"pointer":"/orders/pickups/{business_id}","href":"pickups/upsertpickupbyid","openApiOperationId":"upsertPickupById","summary":"Upsert a Pickup by business Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/Pickup","exampleIds":["paths/~1orders~1pickups~1{business_id}/put/requestBody/content/application~1json/examples/pickup_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pickup","exampleIds":["paths/~1orders~1pickups~1{business_id}/put/requestBody/content/application~1json/examples/pickup_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Order created or updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pickup"}},"schemaId":"components/schemas/Pickup","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_53"},{"code":"204","description":"No Content","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_53"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","description":"Response status code indicates a request conflict with current state of the server.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orders~1pickups~1{business_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Pickup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pickup"}}},{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/orders/pickups/{business_id}"},{"label":"Delete a Pickup by business Id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/pickups/deletepickupbyid","routeSlug":"/apis/order-book/order-book-api/pickups/deletepickupbyid","metadata":{"seo":{"title":"Delete a Pickup by business Id","description":"This endpoint allows you to delete the information about a given pickup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePickupById","name":"Delete a Pickup by business Id","isWebhook":false,"pointer":"/paths/~1orders~1pickups~1{business_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Pickup by business Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to delete the information about a given pickup.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1orders~1pickups~1{business_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/orders/pickups/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","404","412","default"],"pointer":"/orders/pickups/{business_id}","href":"pickups/deletepickupbyid","openApiOperationId":"deletePickupById","summary":"Delete a Pickup by business Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orders~1pickups~1{business_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/orders/pickups/{business_id}"}],"content":{"contentType":"group","meta":{"name":"pickups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pickup Orders","showPageActions":true},{"nodeType":"markdoc","content":"Pickup orders represent an order where the executor needs to pick up cargo at a certain stop."},{"nodeType":"external-docs","url":"https://developer.conundra.eu/developer-portal/order-book/domain/#order","description":"Find out more"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transport-requests/{business_id}/orders/pickups/{order_id}","summary":"Get a Pickup by business id for a given TransportRequest","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pickups/getpickupbytransportrequestidandorderid","deprecated":false},{"title":"/transport-requests/{business_id}/orders/pickups/{order_id}","summary":"Upsert a Pickup by business id for a given TransportRequest","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pickups/upsertpickupbytransportrequestidandorderid","deprecated":false},{"title":"/transport-requests/{business_id}/orders/pickups/{order_id}","summary":"Delete a Pickup by business id for a given TransportRequest","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pickups/deletepickupbytransportrequestidandorderid","deprecated":false},{"title":"/orders/pickups/{business_id}","summary":"Get a Pickup by business Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pickups/getpickupbyid","deprecated":false},{"title":"/orders/pickups/{business_id}","summary":"Upsert a Pickup by business Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pickups/upsertpickupbyid","deprecated":false},{"title":"/orders/pickups/{business_id}","summary":"Delete a Pickup by business Id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pickups/deletepickupbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Delivery Orders","link":"/apis/order-book/order-book-api/deliveries","routeSlug":"/apis/order-book/order-book-api/deliveries","items":[{"label":"Get a Delivery by business id for a given TransportRequest","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/deliveries/getdeliverybytransportrequestidandorderid","routeSlug":"/apis/order-book/order-book-api/deliveries/getdeliverybytransportrequestidandorderid","metadata":{"seo":{"title":"Get a Delivery by business id for a given TransportRequest","description":"This endpoint allows you to get the information about a given delivery."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeliveryByTransportRequestIdAndOrderId","name":"Get a Delivery by business id for a given TransportRequest","isWebhook":false,"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Delivery by business id for a given TransportRequest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to get the information about a given delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is not possible to retrieve deliveries within TransportRequests directly through the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a Delivery by business Id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The identifier of the TransportRequest within which this delivery exists.\n","required":true},{"name":"order_id","in":"path","schemaId":"schema_47","description":"The identifier of a delivery","required":true}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transport-requests/{business_id}/orders/deliveries/{order_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","default"],"pointer":"/transport-requests/{business_id}/orders/deliveries/{order_id}","href":"deliveries/getdeliverybytransportrequestidandorderid","openApiOperationId":"getDeliveryByTransportRequestIdAndOrderId","summary":"Get a Delivery by business id for a given TransportRequest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Delivery"}},"schemaId":"components/schemas/Delivery","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_50"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Delivery","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Delivery"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/{business_id}/orders/deliveries/{order_id}"},{"label":"Upsert a Delivery by business id for a given TransportRequest","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/deliveries/upsertdeliverybytransportrequestidandorderid","routeSlug":"/apis/order-book/order-book-api/deliveries/upsertdeliverybytransportrequestidandorderid","metadata":{"seo":{"title":"Upsert a Delivery by business id for a given TransportRequest","description":"Upsert delivery information. When if-match is not specified, then no optimistic protection is applied, ie: the last update wins."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertDeliveryByTransportRequestIdAndOrderId","name":"Upsert a Delivery by business id for a given TransportRequest","isWebhook":false,"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a Delivery by business id for a given TransportRequest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsert delivery information. When if-match is not specified, then no optimistic protection is applied, ie: the last update wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is not possible to update deliveries within TransportRequests directly through the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsert a Delivery by business Id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The identifier of the TransportRequest within which this delivery must be added/edited.\n","required":true},{"name":"order_id","in":"path","schemaId":"schema_47","description":"The identifier of a delivery instance","required":true}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"},{"name":"Prefer","in":"header","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status codes 200 or 201 with the resource in the response body on success (representation)."},"children":[]}]}]}]}]}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Delivery","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/put/requestBody/content/application~1json/examples/delivery_example"]}},"schemaId":"components/schemas/Delivery","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/put/requestBody/content/application~1json/examples/delivery_example"],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/transport-requests/{business_id}/orders/deliveries/{order_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"},{"name":"Prefer","in":"header","schemaId":"schema_51"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Delivery","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/put/requestBody/content/application~1json/examples/delivery_example"]}},"responseCodes":["201","204","404","409","412","default"],"pointer":"/transport-requests/{business_id}/orders/deliveries/{order_id}","href":"deliveries/upsertdeliverybytransportrequestidandorderid","openApiOperationId":"upsertDeliveryByTransportRequestIdAndOrderId","summary":"Upsert a Delivery by business id for a given TransportRequest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/Delivery","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/put/requestBody/content/application~1json/examples/delivery_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Delivery","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/put/requestBody/content/application~1json/examples/delivery_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Order updated\n\nResponse body contains updated Order\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeliveryInTransportRequest"}},"schemaId":"components/schemas/DeliveryInTransportRequest","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_52"},{"code":"204","description":"No Content","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_52"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","description":"Response status code indicates a request conflict with current state of the server.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/DeliveryInTransportRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeliveryInTransportRequest"}}},{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/{business_id}/orders/deliveries/{order_id}"},{"label":"Delete an Delivery by business id for a given TransportRequest","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/deliveries/deletedeliverybytransportrequestidandorderid","routeSlug":"/apis/order-book/order-book-api/deliveries/deletedeliverybytransportrequestidandorderid","metadata":{"seo":{"title":"Delete an Delivery by business id for a given TransportRequest","description":"This endpoint allows you to delete a given delivery within a transport request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDeliveryByTransportRequestIdAndOrderId","name":"Delete an Delivery by business id for a given TransportRequest","isWebhook":false,"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an Delivery by business id for a given TransportRequest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to delete a given delivery within a transport request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is not possible to delete deliveries within TransportRequests directly through the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a Delivery by business Id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The identifier of the TransportRequest from which this delivery must be removed.\n","required":true},{"name":"order_id","in":"path","schemaId":"schema_47","description":"The identifier of a delivery instance","required":true}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/transport-requests/{business_id}/orders/deliveries/{order_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","404","412","default"],"pointer":"/transport-requests/{business_id}/orders/deliveries/{order_id}","href":"deliveries/deletedeliverybytransportrequestidandorderid","openApiOperationId":"deleteDeliveryByTransportRequestIdAndOrderId","summary":"Delete an Delivery by business id for a given TransportRequest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/{business_id}/orders/deliveries/{order_id}"},{"label":"Get a Delivery by business id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/deliveries/getdeliverybyid","routeSlug":"/apis/order-book/order-book-api/deliveries/getdeliverybyid","metadata":{"seo":{"title":"Get a Delivery by business id","description":"Retrieve a single Delivery Order by its business id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeliveryById","name":"Get a Delivery by business id","isWebhook":false,"pointer":"/paths/~1orders~1deliveries~1{business_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Delivery by business id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a single Delivery Order by its business id.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1orders~1deliveries~1{business_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/deliveries/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","default"],"pointer":"/orders/deliveries/{business_id}","href":"deliveries/getdeliverybyid","openApiOperationId":"getDeliveryById","summary":"Get a Delivery by business id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Delivery"}},"schemaId":"components/schemas/Delivery"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orders~1deliveries~1{business_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Delivery","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Delivery"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/orders/deliveries/{business_id}"},{"label":"Upsert a Delivery by business Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/deliveries/upsertdeliverybyid","routeSlug":"/apis/order-book/order-book-api/deliveries/upsertdeliverybyid","metadata":{"seo":{"title":"Upsert a Delivery by business Id","description":"Create or update a Delivery Order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertDeliveryById","name":"Upsert a Delivery by business Id","isWebhook":false,"pointer":"/paths/~1orders~1deliveries~1{business_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a Delivery by business Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update a Delivery Order.\n\nThis endpoint allows you to update (default behaviour) or insert a Delivery Order. The caller is responsible for\nproviding a unique business identifier for each Order, regardless of order type. If this business identifier can't be found,\na new order will be created. If a Delivery order with the given business identifier can be found then it will be updated.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1orders~1deliveries~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status codes 200 or 201 with the resource in the response body on success (representation)."},"children":[]}]}]}]}]}],"pointer":"/paths/~1orders~1deliveries~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Delivery","exampleIds":["paths/~1orders~1deliveries~1{business_id}/put/requestBody/content/application~1json/examples/delivery_example"]}},"schemaId":"components/schemas/Delivery","exampleIds":["paths/~1orders~1deliveries~1{business_id}/put/requestBody/content/application~1json/examples/delivery_example"],"pointer":"/paths/~1orders~1deliveries~1{business_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/orders/deliveries/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","schemaId":"schema_51"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Delivery","exampleIds":["paths/~1orders~1deliveries~1{business_id}/put/requestBody/content/application~1json/examples/delivery_example"]}},"responseCodes":["201","204","404","409","412","default"],"pointer":"/orders/deliveries/{business_id}","href":"deliveries/upsertdeliverybyid","openApiOperationId":"upsertDeliveryById","summary":"Upsert a Delivery by business Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/Delivery","exampleIds":["paths/~1orders~1deliveries~1{business_id}/put/requestBody/content/application~1json/examples/delivery_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Delivery","exampleIds":["paths/~1orders~1deliveries~1{business_id}/put/requestBody/content/application~1json/examples/delivery_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Order created or updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Delivery"}},"schemaId":"components/schemas/Delivery","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_53"},{"code":"204","description":"No Content","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_53"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","description":"Response status code indicates a request conflict with current state of the server.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orders~1deliveries~1{business_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Delivery","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Delivery"}}},{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/orders/deliveries/{business_id}"},{"label":"Delete a Delivery with specified business Id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/deliveries/deletedeliverybyid","routeSlug":"/apis/order-book/order-book-api/deliveries/deletedeliverybyid","metadata":{"seo":{"title":"Delete a Delivery with specified business Id","description":"This endpoint allows you to delete the information about a given Delivery."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDeliveryById","name":"Delete a Delivery with specified business Id","isWebhook":false,"pointer":"/paths/~1orders~1deliveries~1{business_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Delivery with specified business Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to delete the information about a given Delivery.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1orders~1deliveries~1{business_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/orders/deliveries/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","404","412","default"],"pointer":"/orders/deliveries/{business_id}","href":"deliveries/deletedeliverybyid","openApiOperationId":"deleteDeliveryById","summary":"Delete a Delivery with specified business Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orders~1deliveries~1{business_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/orders/deliveries/{business_id}"}],"content":{"contentType":"group","meta":{"name":"deliveries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delivery Orders","showPageActions":true},{"nodeType":"markdoc","content":"Delivery orders represent an order where the executor needs to drop off cargo at a certain stop."},{"nodeType":"external-docs","url":"https://developer.conundra.eu/developer-portal/order-book/domain/#order","description":"Find out more"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transport-requests/{business_id}/orders/deliveries/{order_id}","summary":"Get a Delivery by business id for a given TransportRequest","prefix":{"name":"get","color":"get"},"badges":[],"link":"/deliveries/getdeliverybytransportrequestidandorderid","deprecated":false},{"title":"/transport-requests/{business_id}/orders/deliveries/{order_id}","summary":"Upsert a Delivery by business id for a given TransportRequest","prefix":{"name":"put","color":"put"},"badges":[],"link":"/deliveries/upsertdeliverybytransportrequestidandorderid","deprecated":false},{"title":"/transport-requests/{business_id}/orders/deliveries/{order_id}","summary":"Delete an Delivery by business id for a given TransportRequest","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/deliveries/deletedeliverybytransportrequestidandorderid","deprecated":false},{"title":"/orders/deliveries/{business_id}","summary":"Get a Delivery by business id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/deliveries/getdeliverybyid","deprecated":false},{"title":"/orders/deliveries/{business_id}","summary":"Upsert a Delivery by business Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/deliveries/upsertdeliverybyid","deprecated":false},{"title":"/orders/deliveries/{business_id}","summary":"Delete a Delivery with specified business Id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/deliveries/deletedeliverybyid","deprecated":false}]}]}]}]}},{"type":"group","label":"PickupDelivery Orders","link":"/apis/order-book/order-book-api/pickupdeliveries","routeSlug":"/apis/order-book/order-book-api/pickupdeliveries","items":[{"label":"Get a PickupDelivery by business id for a given TransportRequest","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/pickupdeliveries/getpickupdeliverybytransportrequestidandorderid","routeSlug":"/apis/order-book/order-book-api/pickupdeliveries/getpickupdeliverybytransportrequestidandorderid","metadata":{"seo":{"title":"Get a PickupDelivery by business id for a given TransportRequest","description":"This endpoint allows you to get the information about a given PickupDelivery."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPickupDeliveryByTransportRequestIdAndOrderId","name":"Get a PickupDelivery by business id for a given TransportRequest","isWebhook":false,"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a PickupDelivery by business id for a given TransportRequest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to get the information about a given PickupDelivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is not possible to retrieve pickupDeliveries within TransportRequests directly through the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a PickupDelivery by business Id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The identifier of the TransportRequest within which this pickupDelivery exists.\n","required":true},{"name":"order_id","in":"path","schemaId":"schema_47","description":"The identifier of a PickupDelivery instance","required":true}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transport-requests/{business_id}/orders/pickup-deliveries/{order_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","default"],"pointer":"/transport-requests/{business_id}/orders/pickup-deliveries/{order_id}","href":"pickupdeliveries/getpickupdeliverybytransportrequestidandorderid","openApiOperationId":"getPickupDeliveryByTransportRequestIdAndOrderId","summary":"Get a PickupDelivery by business id for a given TransportRequest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupDeliveryInTransportRequest"}},"schemaId":"components/schemas/PickupDeliveryInTransportRequest","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_50"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PickupDeliveryInTransportRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupDeliveryInTransportRequest"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/{business_id}/orders/pickup-deliveries/{order_id}"},{"label":"Upsert a PickupDelivery by business id for a given TransportRequest","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/pickupdeliveries/upsertpickupdeliverybytransportrequestidandorderid","routeSlug":"/apis/order-book/order-book-api/pickupdeliveries/upsertpickupdeliverybytransportrequestidandorderid","metadata":{"seo":{"title":"Upsert a PickupDelivery by business id for a given TransportRequest","description":"Upsert PickupDelivery information. When if-match is not specified, then no optimistic protection is applied, ie: the last update wins."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertPickupDeliveryByTransportRequestIdAndOrderId","name":"Upsert a PickupDelivery by business id for a given TransportRequest","isWebhook":false,"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a PickupDelivery by business id for a given TransportRequest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsert PickupDelivery information. When if-match is not specified, then no optimistic protection is applied, ie: the last update wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is not possible to update pickupDeliveries within TransportRequests directly through the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsert a PickupDelivery by business Id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The identifier of the TransportRequest within which this pickupDelivery must be added/edited.\n","required":true},{"name":"order_id","in":"path","schemaId":"schema_47","description":"The identifier of a PickupDelivery instance","required":true}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"},{"name":"Prefer","in":"header","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status codes 200 or 201 with the resource in the response body on success (representation)."},"children":[]}]}]}]}]}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PickupDelivery","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example"]}},"schemaId":"components/schemas/PickupDelivery","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example"],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/transport-requests/{business_id}/orders/pickup-deliveries/{order_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"},{"name":"Prefer","in":"header","schemaId":"schema_51"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PickupDelivery","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example"]}},"responseCodes":["201","204","404","409","412","default"],"pointer":"/transport-requests/{business_id}/orders/pickup-deliveries/{order_id}","href":"pickupdeliveries/upsertpickupdeliverybytransportrequestidandorderid","openApiOperationId":"upsertPickupDeliveryByTransportRequestIdAndOrderId","summary":"Upsert a PickupDelivery by business id for a given TransportRequest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/PickupDelivery","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PickupDelivery","exampleIds":["paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"PickupDelivery updated\n\nResponse body contains updated PickupDelivery\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupDeliveryInTransportRequest"}},"schemaId":"components/schemas/PickupDeliveryInTransportRequest","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_52"},{"code":"204","description":"No Content","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_52"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","description":"Response status code indicates a request conflict with current state of the server.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PickupDeliveryInTransportRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupDeliveryInTransportRequest"}}},{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/{business_id}/orders/pickup-deliveries/{order_id}"},{"label":"Delete a PickupDelivery by business id for a given TransportRequest","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/pickupdeliveries/deletepickupdeliverybytransportrequestidandorderid","routeSlug":"/apis/order-book/order-book-api/pickupdeliveries/deletepickupdeliverybytransportrequestidandorderid","metadata":{"seo":{"title":"Delete a PickupDelivery by business id for a given TransportRequest","description":"This endpoint allows you to delete a given pickupDelivery within a transport request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePickupDeliveryByTransportRequestIdAndOrderId","name":"Delete a PickupDelivery by business id for a given TransportRequest","isWebhook":false,"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a PickupDelivery by business id for a given TransportRequest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to delete a given pickupDelivery within a transport request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is not possible to delete pickupDeliveries within TransportRequests directly through the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a PickupDelivery by business Id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The identifier of the TransportRequest from which this pickupDelivery must be removed.\n","required":true},{"name":"order_id","in":"path","schemaId":"schema_47","description":"The identifier of a PickupDelivery instance","required":true}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/transport-requests/{business_id}/orders/pickup-deliveries/{order_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","404","412","default"],"pointer":"/transport-requests/{business_id}/orders/pickup-deliveries/{order_id}","href":"pickupdeliveries/deletepickupdeliverybytransportrequestidandorderid","openApiOperationId":"deletePickupDeliveryByTransportRequestIdAndOrderId","summary":"Delete a PickupDelivery by business id for a given TransportRequest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/{business_id}/orders/pickup-deliveries/{order_id}"},{"label":"Get a PickupDelivery by business Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/pickupdeliveries/getpickupdeliverybyid","routeSlug":"/apis/order-book/order-book-api/pickupdeliveries/getpickupdeliverybyid","metadata":{"seo":{"title":"Get a PickupDelivery by business Id","description":"Create or update a PickupDelivery Order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPickupDeliveryById","name":"Get a PickupDelivery by business Id","isWebhook":false,"pointer":"/paths/~1orders~1pickup-deliveries~1{business_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a PickupDelivery by business Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update a PickupDelivery Order.\n\nThis endpoint allows you to update (default behaviour) or insert a PickupDelivery Order. The caller is responsible for\nproviding a unique business identifier for each Order, regardless of order type. If this business identifier can't be found,\na new order will be created. If a PickupDelivery order with the given business identifier can be found then it will be updated.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1orders~1pickup-deliveries~1{business_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/pickup-deliveries/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","default"],"pointer":"/orders/pickup-deliveries/{business_id}","href":"pickupdeliveries/getpickupdeliverybyid","openApiOperationId":"getPickupDeliveryById","summary":"Get a PickupDelivery by business Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupDelivery"}},"schemaId":"components/schemas/PickupDelivery"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orders~1pickup-deliveries~1{business_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PickupDelivery","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupDelivery"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/orders/pickup-deliveries/{business_id}"},{"label":"Upsert a PickupDelivery by business Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/pickupdeliveries/upsertpickupdeliverybyid","routeSlug":"/apis/order-book/order-book-api/pickupdeliveries/upsertpickupdeliverybyid","metadata":{"seo":{"title":"Upsert a PickupDelivery by business Id","description":"Upsert PickupDelivery information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertPickupDeliveryById","name":"Upsert a PickupDelivery by business Id","isWebhook":false,"pointer":"/paths/~1orders~1pickup-deliveries~1{business_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a PickupDelivery by business Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Upsert PickupDelivery information.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1orders~1pickup-deliveries~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status codes 200 or 201 with the resource in the response body on success (representation)."},"children":[]}]}]}]}]}],"pointer":"/paths/~1orders~1pickup-deliveries~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PickupDelivery","exampleIds":["paths/~1orders~1pickup-deliveries~1{business_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example"]}},"schemaId":"components/schemas/PickupDelivery","exampleIds":["paths/~1orders~1pickup-deliveries~1{business_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example"],"pointer":"/paths/~1orders~1pickup-deliveries~1{business_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/orders/pickup-deliveries/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","schemaId":"schema_51"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PickupDelivery","exampleIds":["paths/~1orders~1pickup-deliveries~1{business_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example"]}},"responseCodes":["201","204","404","409","412","default"],"pointer":"/orders/pickup-deliveries/{business_id}","href":"pickupdeliveries/upsertpickupdeliverybyid","openApiOperationId":"upsertPickupDeliveryById","summary":"Upsert a PickupDelivery by business Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/PickupDelivery","exampleIds":["paths/~1orders~1pickup-deliveries~1{business_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PickupDelivery","exampleIds":["paths/~1orders~1pickup-deliveries~1{business_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Order created or updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupDelivery"}},"schemaId":"components/schemas/PickupDelivery","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_53"},{"code":"204","description":"No Content","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_53"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","description":"Response status code indicates a request conflict with current state of the server.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orders~1pickup-deliveries~1{business_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PickupDelivery","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupDelivery"}}},{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/orders/pickup-deliveries/{business_id}"},{"label":"Delete a PickupDelivery by business Id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/pickupdeliveries/deletepickupdeliverybyid","routeSlug":"/apis/order-book/order-book-api/pickupdeliveries/deletepickupdeliverybyid","metadata":{"seo":{"title":"Delete a PickupDelivery by business Id","description":"This endpoint allows you to delete the information about a given PickupDelivery."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePickupDeliveryById","name":"Delete a PickupDelivery by business Id","isWebhook":false,"pointer":"/paths/~1orders~1pickup-deliveries~1{business_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a PickupDelivery by business Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to delete the information about a given PickupDelivery.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1orders~1pickup-deliveries~1{business_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/orders/pickup-deliveries/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","404","412","default"],"pointer":"/orders/pickup-deliveries/{business_id}","href":"pickupdeliveries/deletepickupdeliverybyid","openApiOperationId":"deletePickupDeliveryById","summary":"Delete a PickupDelivery by business Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1orders~1pickup-deliveries~1{business_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/orders/pickup-deliveries/{business_id}"}],"content":{"contentType":"group","meta":{"name":"pickupdeliveries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PickupDelivery Orders","showPageActions":true},{"nodeType":"markdoc","content":"PickupDelivery orders represent an order where the executor needs to pick up cargo at a certain stop and deliver it at another stop."},{"nodeType":"external-docs","url":"https://developer.conundra.eu/developer-portal/order-book/domain/#order","description":"Find out more"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transport-requests/{business_id}/orders/pickup-deliveries/{order_id}","summary":"Get a PickupDelivery by business id for a given TransportRequest","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pickupdeliveries/getpickupdeliverybytransportrequestidandorderid","deprecated":false},{"title":"/transport-requests/{business_id}/orders/pickup-deliveries/{order_id}","summary":"Upsert a PickupDelivery by business id for a given TransportRequest","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pickupdeliveries/upsertpickupdeliverybytransportrequestidandorderid","deprecated":false},{"title":"/transport-requests/{business_id}/orders/pickup-deliveries/{order_id}","summary":"Delete a PickupDelivery by business id for a given TransportRequest","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pickupdeliveries/deletepickupdeliverybytransportrequestidandorderid","deprecated":false},{"title":"/orders/pickup-deliveries/{business_id}","summary":"Get a PickupDelivery by business Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pickupdeliveries/getpickupdeliverybyid","deprecated":false},{"title":"/orders/pickup-deliveries/{business_id}","summary":"Upsert a PickupDelivery by business Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pickupdeliveries/upsertpickupdeliverybyid","deprecated":false},{"title":"/orders/pickup-deliveries/{business_id}","summary":"Delete a PickupDelivery by business Id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pickupdeliveries/deletepickupdeliverybyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Consolidated Orders","link":"/apis/order-book/order-book-api/consolidated-orders","routeSlug":"/apis/order-book/order-book-api/consolidated-orders","items":[{"label":"Get a cursor paged list of consolidated orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/consolidated-orders/getconsolidatedorders","routeSlug":"/apis/order-book/order-book-api/consolidated-orders/getconsolidatedorders","metadata":{"seo":{"title":"Get a cursor paged list of consolidated orders","description":"This endpoint allows you to retrieve a cursor paged list of information on consolidated orders, based on their plannability. We currently only support returninginformation on Orders that have become unplannable after consolidating the orders' timeframes with their Location and applicable Conditionals."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConsolidatedOrders","name":"Get a cursor paged list of consolidated orders","isWebhook":false,"pointer":"/paths/~1consolidated-orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a cursor paged list of consolidated orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to retrieve a cursor paged list of information on "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"consolidated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" orders, based on their "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plannability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". We currently only support returning"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information on Orders that have become "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unplannable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after consolidating the orders' timeframes with their Location and applicable Conditionals."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can find out more about how to use cursors in our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.conundra.eu/developer-portal/cursor-paging/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"developer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"plannability","in":"query","schemaId":"schema_54","required":true},{"name":"cursor","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor of the page to retrieve. Can be left blank initially to retrieve the first page. Paging through the results requires passing in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from a previous response."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_48","description":"Number of results per page."}],"pointer":"/paths/~1consolidated-orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/consolidated-orders","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[],"query":[{"name":"plannability","in":"query","required":true,"schemaId":"schema_54"},{"name":"cursor","in":"query","schemaId":"schema_47"},{"name":"limit","in":"query","schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/consolidated-orders","href":"consolidated-orders/getconsolidatedorders","openApiOperationId":"getConsolidatedOrders","summary":"Get a cursor paged list of consolidated orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsolidatedOrders"}},"schemaId":"components/schemas/ConsolidatedOrders"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1consolidated-orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsolidatedOrders","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsolidatedOrders"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/consolidated-orders"}],"content":{"contentType":"group","meta":{"name":"consolidated orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consolidated Orders","showPageActions":true},{"nodeType":"markdoc","content":"Orders are being consolidated by the application to enrich them with captured domain knowledge through Conditionals and/or Locations. These endpoints provide\ninsights into and discoverability of the results of this consolidation."},{"nodeType":"external-docs","url":"https://developer.conundra.eu/developer-portal/order-book/domain/#consolidation","description":"Find out more"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/consolidated-orders","summary":"Get a cursor paged list of consolidated orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consolidated-orders/getconsolidatedorders","deprecated":false}]}]}]}]}},{"type":"group","label":"Category Management","link":"/apis/order-book/order-book-api/categories","routeSlug":"/apis/order-book/order-book-api/categories","items":[{"label":"[EXPERIMENTAL] Get list of all categories of an entity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/categories/getcategoriesofentity","routeSlug":"/apis/order-book/order-book-api/categories/getcategoriesofentity","metadata":{"seo":{"title":"[EXPERIMENTAL] Get list of all categories of an entity","description":"[EXPERIMENTAL] This endpoint allows you to retrieve list of categories of an entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCategoriesOfEntity","name":"[EXPERIMENTAL] Get list of all categories of an entity","isWebhook":false,"pointer":"/paths/~1categories~1{entity}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get list of all categories of an entity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint allows you to retrieve list of categories of an entity."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entity","in":"path","schemaId":"schema_55","description":"The unique entity for a type","required":true}],"pointer":"/paths/~1categories~1{entity}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_56","description":"Number of the page to retrieve, see also Paging section."},{"name":"page_size","in":"query","schemaId":"schema_57","description":"Number of results by page, see also Paging section."}],"pointer":"/paths/~1categories~1{entity}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/categories/{entity}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"entity","in":"path","required":true,"schemaId":"schema_55"}],"query":[{"name":"page","in":"query","schemaId":"schema_56"},{"name":"page_size","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/categories/{entity}","href":"categories/getcategoriesofentity","openApiOperationId":"getCategoriesOfEntity","summary":"[EXPERIMENTAL] Get list of all categories of an entity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityCategories"}},"schemaId":"components/schemas/EntityCategories"}],"pointer":"/paths/~1categories~1{entity}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityCategories","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityCategories"}}}],"examples":[]}]}]}]},"httpPath":"/categories/{entity}"},{"label":"[EXPERIMENTAL] Get a category of an entity with specified code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/categories/getcategoryofentitybycode","routeSlug":"/apis/order-book/order-book-api/categories/getcategoryofentitybycode","metadata":{"seo":{"title":"[EXPERIMENTAL] Get a category of an entity with specified code","description":"[EXPERIMENTAL] This endpoint allows you to get the category of an entity with a given code, including the ETag header for optimistic locking purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCategoryOfEntityByCode","name":"[EXPERIMENTAL] Get a category of an entity with specified code","isWebhook":false,"pointer":"/paths/~1categories~1{entity}~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get a category of an entity with specified code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint allows you to get the category of an entity with a given code, including the ETag header for optimistic locking purpose"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entity","in":"path","schemaId":"schema_55","description":"The unique entity for a type","required":true},{"name":"code","in":"path","schemaId":"schema_47","description":"The unique identifier for a type","required":true}],"pointer":"/paths/~1categories~1{entity}~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/categories/{entity}/{code}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"entity","in":"path","required":true,"schemaId":"schema_55"},{"name":"code","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","default"],"pointer":"/categories/{entity}/{code}","href":"categories/getcategoryofentitybycode","openApiOperationId":"getCategoryOfEntityByCode","summary":"[EXPERIMENTAL] Get a category of an entity with specified code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityCategory"}},"schemaId":"components/schemas/EntityCategory","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_50"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1categories~1{entity}~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityCategory"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/categories/{entity}/{code}"},{"label":"[EXPERIMENTAL] Create or Update a category of an entity with specified code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/categories/createorupdatetypeofentity","routeSlug":"/apis/order-book/order-book-api/categories/createorupdatetypeofentity","metadata":{"seo":{"title":"[EXPERIMENTAL] Create or Update a category of an entity with specified code","description":"[EXPERIMENTAL] This endpoint allows you to create or update an existing category of an entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrUpdateTypeOfEntity","name":"[EXPERIMENTAL] Create or Update a category of an entity with specified code","isWebhook":false,"pointer":"/paths/~1categories~1{entity}~1{code}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Create or Update a category of an entity with specified code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint allows you to create or update an existing category of an entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the code does not exist, a new category will be created for the entity. No ETag header is required yet."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a given code, the properties will be overwritten and then an ETag header is required. Do remark that the code in the body of the request, must correspond with the code in the path identifier"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entity","in":"path","schemaId":"schema_55","description":"The unique entity for a type","required":true},{"name":"code","in":"path","schemaId":"schema_47","description":"The unique identifier for a type","required":true}],"pointer":"/paths/~1categories~1{entity}~1{code}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1categories~1{entity}~1{code}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityCategory"}},"schemaId":"components/schemas/EntityCategory","pointer":"/paths/~1categories~1{entity}~1{code}/put/requestBody","description":"Update category of an entity request body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/categories/{entity}/{code}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"entity","in":"path","required":true,"schemaId":"schema_55"},{"name":"code","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EntityCategory"}},"responseCodes":["204","401","403","404","412"],"pointer":"/categories/{entity}/{code}","href":"categories/createorupdatetypeofentity","openApiOperationId":"createOrUpdateTypeOfEntity","summary":"[EXPERIMENTAL] Create or Update a category of an entity with specified code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/EntityCategory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityCategory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Update successful","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_50"},{"code":"401","description":"Authentication required","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1categories~1{entity}~1{code}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/categories/{entity}/{code}"},{"label":"[EXPERIMENTAL] Delete an existing category of entity with specified code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/categories/deleteentitycategorytype","routeSlug":"/apis/order-book/order-book-api/categories/deleteentitycategorytype","metadata":{"seo":{"title":"[EXPERIMENTAL] Delete an existing category of entity with specified code","description":"[EXPERIMENTAL] This endpoint allows you to delete an existing category of an entity"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEntityCategoryType","name":"[EXPERIMENTAL] Delete an existing category of entity with specified code","isWebhook":false,"pointer":"/paths/~1categories~1{entity}~1{code}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Delete an existing category of entity with specified code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint allows you to delete an existing category of an entity"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A category can only be deleted when no active entities are still using it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entity","in":"path","schemaId":"schema_55","description":"The unique entity for a type","required":true},{"name":"code","in":"path","schemaId":"schema_47","description":"The unique identifier for a type","required":true}],"pointer":"/paths/~1categories~1{entity}~1{code}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1categories~1{entity}~1{code}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/categories/{entity}/{code}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"entity","in":"path","required":true,"schemaId":"schema_55"},{"name":"code","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","401","403","404","412"],"pointer":"/categories/{entity}/{code}","href":"categories/deleteentitycategorytype","openApiOperationId":"deleteEntityCategoryType","summary":"[EXPERIMENTAL] Delete an existing category of entity with specified code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delete successful"},{"code":"401","description":"Authentication required","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1categories~1{entity}~1{code}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/categories/{entity}/{code}"}],"content":{"contentType":"group","meta":{"name":"categories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Category Management","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Endpoints for managing Categories."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Experimental Status:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" These endpoints have an experimental status since their complexity was impacted by a removed feature. We intend at the very least"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to vastly simplify these endpoints by removing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-subresource."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/categories/{entity}","summary":"[EXPERIMENTAL] Get list of all categories of an entity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/categories/getcategoriesofentity","deprecated":false},{"title":"/categories/{entity}/{code}","summary":"[EXPERIMENTAL] Get a category of an entity with specified code","prefix":{"name":"get","color":"get"},"badges":[],"link":"/categories/getcategoryofentitybycode","deprecated":false},{"title":"/categories/{entity}/{code}","summary":"[EXPERIMENTAL] Create or Update a category of an entity with specified code","prefix":{"name":"put","color":"put"},"badges":[],"link":"/categories/createorupdatetypeofentity","deprecated":false},{"title":"/categories/{entity}/{code}","summary":"[EXPERIMENTAL] Delete an existing category of entity with specified code","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/categories/deleteentitycategorytype","deprecated":false}]}]}]}]}},{"type":"separator","label":"Grouping Orders","content":null},{"type":"group","label":"Transport Requests","link":"/apis/order-book/order-book-api/transport-request","routeSlug":"/apis/order-book/order-book-api/transport-request","items":[{"label":"Get a list of all transport requests by ids","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/transport-request/getlistoftransportrequests","routeSlug":"/apis/order-book/order-book-api/transport-request/getlistoftransportrequests","metadata":{"seo":{"title":"Get a list of all transport requests by ids","description":"This is an endpoint that allows you to retrieve a list of Transport Requests in bulk. The Transport Requests are identified by their business id, provided in the query."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfTransportRequests","name":"Get a list of all transport requests by ids","isWebhook":false,"pointer":"/paths/~1transport-requests/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of all transport requests by ids","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This is an endpoint that allows you to retrieve a list of Transport Requests in bulk. The Transport Requests are identified by their business id, provided \nin the query. \n\nWhen one or more transport requests could not be found, this will be indicated in the errors-section of the response.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ids","in":"query","schemaId":"schema_58","description":"A comma-separated list of Transport Request business IDs.\n","required":true}],"pointer":"/paths/~1transport-requests/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transport-requests","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[],"query":[{"name":"ids","in":"query","required":true,"schemaId":"schema_58","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/transport-requests","href":"transport-request/getlistoftransportrequests","openApiOperationId":"getListOfTransportRequests","summary":"Get a list of all transport requests by ids"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"a list of transport requests\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkTransportRequestResponse"}},"schemaId":"components/schemas/BulkTransportRequestResponse"}],"pointer":"/paths/~1transport-requests/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkTransportRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkTransportRequestResponse"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests"},{"label":"Get a list of transport request by filter criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/transport-request/getcursorpagedtransportrequests","routeSlug":"/apis/order-book/order-book-api/transport-request/getcursorpagedtransportrequests","metadata":{"seo":{"title":"Get a list of transport request by filter criteria","description":"Retrieve a list of Transport Requests in bulk, identified by the query parameters defined in the request. Providing no query parameters will return allknown Transport Requests. Providing any additional filter will return the matching subset of Transport Requests. When providing multiple filter parameters,all filters must match for a Transport Request to be included in the response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCursorPagedTransportRequests","name":"Get a list of transport request by filter criteria","isWebhook":false,"pointer":"/paths/~1transport-requests~1by/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of transport request by filter criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a list of Transport Requests in bulk, identified by the query parameters defined in the request. Providing no query parameters will return all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"known Transport Requests. Providing any additional filter will return the matching subset of Transport Requests. When providing multiple filter parameters,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all filters must match for a Transport Request to be included in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since Transport Requests are volatile data, this endpoints returns a cursor-based paged list. Paging through the results requires you to call the API using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prev"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". These will return the next batch of up to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can find out more about how to use cursors in our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.conundra.eu/developer-portal/cursor-paging/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"developer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_at","in":"query","schemaId":"schema_59","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ISO-8601 formatted date, that acts as the lower bound for which the Transport Request must be applicable, ie: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"earliest_start_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be equal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to or larger than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"end_at","in":"query","schemaId":"schema_59","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ISO-8601 formatted date, that acts as the lower bound for which the Transport Request must be applicable, ie: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"earliest_start_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be smaller than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor of the page to retrieve. Can be left blank initially to retrieve the first page. Paging through the results requires passing in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from a previous response."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_48","description":"Number of results per page."}],"pointer":"/paths/~1transport-requests~1by/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transport-requests/by","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[],"query":[{"name":"start_at","in":"query","schemaId":"schema_59"},{"name":"end_at","in":"query","schemaId":"schema_59"},{"name":"cursor","in":"query","schemaId":"schema_47"},{"name":"limit","in":"query","schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/transport-requests/by","href":"transport-request/getcursorpagedtransportrequests","openApiOperationId":"getCursorPagedTransportRequests","summary":"Get a list of transport request by filter criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A cursor-based paged set of Transport Requests. The set might be empty if no Transport Requests match the query.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageTransportRequests"}},"schemaId":"components/schemas/CursorPageTransportRequests"}],"pointer":"/paths/~1transport-requests~1by/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPageTransportRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageTransportRequests"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/by"},{"label":"Get a transport request with specified business id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/transport-request/gettransportrequestbyid","routeSlug":"/apis/order-book/order-book-api/transport-request/gettransportrequestbyid","metadata":{"seo":{"title":"Get a transport request with specified business id","description":"Retrieve a single Transport Request by its business id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransportRequestById","name":"Get a transport request with specified business id","isWebhook":false,"pointer":"/paths/~1transport-requests~1{business_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a transport request with specified business id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a single Transport Request by its business id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1transport-requests~1{business_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Conundra-Unwrap","in":"header","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to true, the response will not be wrapped in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}],"pointer":"/paths/~1transport-requests~1{business_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transport-requests/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"X-Conundra-Unwrap","in":"header","required":false,"schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","default"],"pointer":"/transport-requests/{business_id}","href":"transport-request/gettransportrequestbyid","openApiOperationId":"getTransportRequestById","summary":"Get a transport request with specified business id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingleTransportRequestLookupResponse"}},"schemaId":"components/schemas/SingleTransportRequestLookupResponse","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_50"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-requests~1{business_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SingleTransportRequestLookupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingleTransportRequestLookupResponse"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/{business_id}"},{"label":"Upsert a Transport Request with specified business id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/transport-request/upserttransportrequestbyid","routeSlug":"/apis/order-book/order-book-api/transport-request/upserttransportrequestbyid","metadata":{"seo":{"title":"Upsert a Transport Request with specified business id","description":"Create or update a Transport Request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertTransportRequestById","name":"Upsert a Transport Request with specified business id","isWebhook":false,"pointer":"/paths/~1transport-requests~1{business_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a Transport Request with specified business id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update a Transport Request.\n\nThis endpoint allows you to update (default behaviour) or insert a new transport request. The caller is responsible for\nproviding a unique business identifier for each Transport Request. If this business identifier can't be found,\na new transport request will be created. If a transport request with the given business identifier can be found\nthen it will be updated. \n\nWhen you specify an 'if-match' header with a weak ETAG representing the version, optimistic locking will be applied to your operation.\nShould a conflict be detected, a 412 PreconditionFailed response is returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1transport-requests~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"},{"name":"Prefer","in":"header","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status codes 200 or 201 with the resource in the response body on success (representation)."},"children":[]}]}]}]}]}],"pointer":"/paths/~1transport-requests~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransportRequest"}},"schemaId":"components/schemas/TransportRequest","pointer":"/paths/~1transport-requests~1{business_id}/put/requestBody","description":"Transport Request to be updated"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/transport-requests/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"},{"name":"Prefer","in":"header","schemaId":"schema_51"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransportRequest"}},"responseCodes":["201","204","404","409","412","default"],"pointer":"/transport-requests/{business_id}","href":"transport-request/upserttransportrequestbyid","openApiOperationId":"upsertTransportRequestById","summary":"Upsert a Transport Request with specified business id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/TransportRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransportRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Transport Request updated\n\nResponse body contains updated Transport Request\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingleTransportRequestLookupResponse"}},"schemaId":"components/schemas/SingleTransportRequestLookupResponse","headers":{"Location":{"schema":{"type":"string"},"description":"contains the URI, with the ID of the created Transport Request ex /transport-requests"},"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_60"},{"code":"204","description":"Transport Request updated\n\nResponse body is empty\n","headers":{"Location":{"schema":{"type":"string"},"description":"contains the URI, with the ID of the created Transport Request ex /transport-requests"},"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_60"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","description":"Response status code indicates a request conflict with current state of the server.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-requests~1{business_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/SingleTransportRequestLookupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingleTransportRequestLookupResponse"}}},{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/{business_id}"},{"label":"Delete a transport request with specified Id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/transport-request/deletetransportrequestbyid","routeSlug":"/apis/order-book/order-book-api/transport-request/deletetransportrequestbyid","metadata":{"seo":{"title":"Delete a transport request with specified Id","description":"This endpoint allows you to delete the information about a given TransportRequest. Deleting a Transport Request will also delete all orders within it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTransportRequestById","name":"Delete a transport request with specified Id","isWebhook":false,"pointer":"/paths/~1transport-requests~1{business_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a transport request with specified Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to delete the information about a given TransportRequest. Deleting a Transport Request will also delete all orders within it.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1transport-requests~1{business_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1transport-requests~1{business_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/transport-requests/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","404","default"],"pointer":"/transport-requests/{business_id}","href":"transport-request/deletetransportrequestbyid","openApiOperationId":"deleteTransportRequestById","summary":"Delete a transport request with specified Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deletion has succeeded, but body is empty"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-requests~1{business_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-requests/{business_id}"}],"content":{"contentType":"group","meta":{"name":"transport request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transport Requests","showPageActions":true},{"nodeType":"markdoc","content":"Transport Requests can be used to group Orders that share some administrative context. They can serve as a way of targeting Orders through conditionals,\nby providing context on the client companies for which those orders are being executed."},{"nodeType":"external-docs","url":"https://developer.conundra.eu/developer-portal/order-book/domain/#transport-request","description":"Find out more"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transport-requests","summary":"Get a list of all transport requests by ids","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transport-request/getlistoftransportrequests","deprecated":false},{"title":"/transport-requests/by","summary":"Get a list of transport request by filter criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transport-request/getcursorpagedtransportrequests","deprecated":false},{"title":"/transport-requests/{business_id}","summary":"Get a transport request with specified business id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transport-request/gettransportrequestbyid","deprecated":false},{"title":"/transport-requests/{business_id}","summary":"Upsert a Transport Request with specified business id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/transport-request/upserttransportrequestbyid","deprecated":false},{"title":"/transport-requests/{business_id}","summary":"Delete a transport request with specified Id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/transport-request/deletetransportrequestbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Companies","link":"/apis/order-book/order-book-api/companies","routeSlug":"/apis/order-book/order-book-api/companies","items":[{"label":"Get a Company with specified business id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/companies/getcompanybyid","routeSlug":"/apis/order-book/order-book-api/companies/getcompanybyid","metadata":{"seo":{"title":"Get a Company with specified business id","description":"Retrieve a single Company by its business id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCompanyById","name":"Get a Company with specified business id","isWebhook":false,"pointer":"/paths/~1companies~1{business_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Company with specified business id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a single Company by its business id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1companies~1{business_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/companies/{business_id}","href":"companies/getcompanybyid","openApiOperationId":"getCompanyById","summary":"Get a Company with specified business id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Company"}},"schemaId":"components/schemas/Company","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_50"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1companies~1{business_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Company","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Company"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/companies/{business_id}"},{"label":"Upsert a company by Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/companies/updatecompanybyid","routeSlug":"/apis/order-book/order-book-api/companies/updatecompanybyid","metadata":{"seo":{"title":"Upsert a company by Id","description":"This endpoint allows you to update (default behaviour) or insert a new Company. You are responsible to give a unique business identifier with your company. If this business identifier can't be found then a new company will be created. If a company with the given business identifier can be found then it will be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCompanyById","name":"Upsert a company by Id","isWebhook":false,"pointer":"/paths/~1companies~1{business_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a company by Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to update (default behaviour) or insert a new Company. You are responsible to\ngive a unique business identifier with your company. If this business identifier can't be found\nthen a new company will be created. If a company with the given business identifier can be found\nthen it will be updated. \n\nWhen you specify 'if-match', which is filled in with a weak ETAG representing a version, then you can protect yourself from updates by someone else \nbefore committing your updates. (see also Optimistic locking). When such a conflict is detected, a 412 PreconditionFailed response is returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1companies~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status codes 200 or 201 with the resource in the response body on success (representation)."},"children":[]}]}]}]}]},{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1companies~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Company"}},"schemaId":"components/schemas/Company","pointer":"/paths/~1companies~1{business_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/companies/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","schemaId":"schema_51"},{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Company"}},"responseCodes":["200","204","404","412","default"],"pointer":"/companies/{business_id}","href":"companies/updatecompanybyid","openApiOperationId":"updateCompanyById","summary":"Upsert a company by Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/Company","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Company"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Company"}},"schemaId":"components/schemas/Company","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_52"},{"code":"204","description":"Created successfully","headers":{"Location":{"schema":{"type":"string"},"description":"contains the URI, with the business ID of the created company"},"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_61"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1companies~1{business_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Company","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Company"}}},{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/companies/{business_id}"},{"label":"Delete a company by Id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/companies/deletecompanybyid","routeSlug":"/apis/order-book/order-book-api/companies/deletecompanybyid","metadata":{"seo":{"title":"Delete a company by Id","description":"This endpoint allows you to delete a given company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCompanyById","name":"Delete a company by Id","isWebhook":false,"pointer":"/paths/~1companies~1{business_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a company by Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to delete a given company\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1companies~1{business_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1companies~1{business_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/companies/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","404","412","default"],"pointer":"/companies/{business_id}","href":"companies/deletecompanybyid","openApiOperationId":"deleteCompanyById","summary":"Delete a company by Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deletion has succeeded and body is empty\n"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1companies~1{business_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/companies/{business_id}"}],"content":{"contentType":"group","meta":{"name":"companies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Companies","showPageActions":true},{"nodeType":"markdoc","content":"Companies can be managed in Order Book and used as clients for Transport Requests. This allows you to target Conditionals to Orders contained within Transport Requests for select clients."},{"nodeType":"external-docs","url":"https://developer.conundra.eu/developer-portal/order-book/domain/#company","description":"Find out more"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{business_id}","summary":"Get a Company with specified business id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/getcompanybyid","deprecated":false},{"title":"/companies/{business_id}","summary":"Upsert a company by Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/companies/updatecompanybyid","deprecated":false},{"title":"/companies/{business_id}","summary":"Delete a company by Id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/companies/deletecompanybyid","deprecated":false}]}]}]}]}},{"type":"separator","label":"Extending Orders","content":null},{"type":"group","label":"Locations","link":"/apis/order-book/order-book-api/locations","routeSlug":"/apis/order-book/order-book-api/locations","items":[{"label":"Get a list of all locations by ids","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/locations/getpagedlocations","routeSlug":"/apis/order-book/order-book-api/locations/getpagedlocations","metadata":{"seo":{"title":"Get a list of all locations by ids","description":"This is an endpoint that allows you to retrieve a list of Locations in bulk. The locations are identified by their business id, provided in the query."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPagedLocations","name":"Get a list of all locations by ids","isWebhook":false,"pointer":"/paths/~1locations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of all locations by ids","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This is an endpoint that allows you to retrieve a list of Locations in bulk. The locations are identified by their business id, provided in the query. \n\nWhen one or more locations could not be found, this will be indicated in the errors-section of the response.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ids","in":"query","schemaId":"schema_58","description":"A comma-separated list of Location business IDs.","required":true}],"pointer":"/paths/~1locations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[],"query":[{"name":"ids","in":"query","required":true,"schemaId":"schema_58","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/locations","href":"locations/getpagedlocations","openApiOperationId":"getPagedLocations","summary":"Get a list of all locations by ids"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"a list of locations\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkLocationResponse"}},"schemaId":"components/schemas/BulkLocationResponse"}],"pointer":"/paths/~1locations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkLocationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkLocationResponse"}}}],"examples":[]}]}]}]},"httpPath":"/locations"},{"label":"Get a list of locations by filter criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/locations/getpagedlocationsby","routeSlug":"/apis/order-book/order-book-api/locations/getpagedlocationsby","metadata":{"seo":{"title":"Get a list of locations by filter criteria","description":"Retrieve a list of Locations in bulk, identified by the query parameters defined in the request. The query requires at least a page and page size, in which case all Locations will be returned in a paged format. Providing any additional filter will return the matching subset of Locations. When providing multiple filter parameters, all filters must match for a Location to be included in the response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPagedLocationsBy","name":"Get a list of locations by filter criteria","isWebhook":false,"pointer":"/paths/~1locations~1by/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of locations by filter criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of Locations in bulk, identified by the query parameters defined in the request. The query requires at least a page and page size, in \nwhich case all Locations will be returned in a paged format. Providing any additional filter will return the matching subset of Locations. When providing \nmultiple filter parameters, all filters must match for a Location to be included in the response.\n\nThe returned list can be empty, but the request will not fail if no results are found.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"location_category","in":"query","schemaId":"schema_47","description":"Filter results based on category"},{"name":"country_code","in":"query","schemaId":"schema_62","description":"Filter results based on country identifier (ISO3166-1 alpha-2)."},{"name":"zip_code","in":"query","schemaId":"schema_47","description":"Filter results based on ZIP code"},{"name":"city","in":"query","schemaId":"schema_47","description":"Filter results based on city"},{"name":"address_line","in":"query","schemaId":"schema_47","description":"collection filtered on address line"},{"name":"page","in":"query","schemaId":"schema_56","description":"Number of the page to retrieve, see also Paging section."},{"name":"page_size","in":"query","schemaId":"schema_57","description":"Number of results by page, see also Paging section."}],"pointer":"/paths/~1locations~1by/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/by","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[],"query":[{"name":"location_category","in":"query","schemaId":"schema_47"},{"name":"country_code","in":"query","example":"BE","schemaId":"components/schemas/CountryCode"},{"name":"zip_code","in":"query","schemaId":"schema_47"},{"name":"city","in":"query","schemaId":"schema_47"},{"name":"address_line","in":"query","schemaId":"schema_47"},{"name":"page","in":"query","schemaId":"schema_56"},{"name":"page_size","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/locations/by","href":"locations/getpagedlocationsby","openApiOperationId":"getPagedLocationsBy","summary":"Get a list of locations by filter criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"a list of locations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Locations"}},"schemaId":"components/schemas/Locations"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1locations~1by/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Locations","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Locations"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/locations/by"},{"label":"Get a location with specified business Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/locations/getlocationbyid","routeSlug":"/apis/order-book/order-book-api/locations/getlocationbyid","metadata":{"seo":{"title":"Get a location with specified business Id","description":"Retrieve a single location by its business id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLocationById","name":"Get a location with specified business Id","isWebhook":false,"pointer":"/paths/~1locations~1{business_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a location with specified business Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a single location by its business id.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1locations~1{business_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Conundra-Unwrap","in":"header","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to true, the response will not be wrapped in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}],"pointer":"/paths/~1locations~1{business_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"X-Conundra-Unwrap","in":"header","required":false,"schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","default"],"pointer":"/locations/{business_id}","href":"locations/getlocationbyid","openApiOperationId":"getLocationById","summary":"Get a location with specified business Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingleLocationLookupResponse"}},"schemaId":"components/schemas/SingleLocationLookupResponse","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_50"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1locations~1{business_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SingleLocationLookupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingleLocationLookupResponse"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/locations/{business_id}"},{"label":"Upsert a location with specified business Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/locations/upsertlocationbyid","routeSlug":"/apis/order-book/order-book-api/locations/upsertlocationbyid","metadata":{"seo":{"title":"Upsert a location with specified business Id","description":"Create of update a location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertLocationById","name":"Upsert a location with specified business Id","isWebhook":false,"pointer":"/paths/~1locations~1{business_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert a location with specified business Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create of update a location. \n\nThe caller is responsible for providing a unique business id for each Location to retain consistency. If a call is made using an unknown business id, a \nnew Location will be created, otherwise an update will be applied to the existing Location. Locations are versioned and the ETag-header will represent the \ntype of operation that was executed. Conversely, adding an If-Match header to requests can protect the caller against unintended operations by acting as\nan optimistic lock.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1locations~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"},{"name":"Prefer","in":"header","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status codes 200 or 201 with the resource in the response body on success (representation)."},"children":[]}]}]}]}]}],"pointer":"/paths/~1locations~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Location"}},"schemaId":"components/schemas/Location","pointer":"/paths/~1locations~1{business_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/locations/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"},{"name":"Prefer","in":"header","schemaId":"schema_51"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Location"}},"responseCodes":["201","204","404","412","default"],"pointer":"/locations/{business_id}","href":"locations/upsertlocationbyid","openApiOperationId":"upsertLocationById","summary":"Upsert a location with specified business Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/Location","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Location"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the locations is created or updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response body contains the location, since Prefer is set to return=representation."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingleLocationLookupResponse"}},"schemaId":"components/schemas/SingleLocationLookupResponse","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_52"},{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the locations is created or updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response body will be empty, this is the default behaviour or the case when the Prefer-header is set to return=minimal."},"children":[]}]}]}],"headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_52"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1locations~1{business_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/SingleLocationLookupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingleLocationLookupResponse"}}},{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/locations/{business_id}"},{"label":"Delete a location with specified business id.\n","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/locations/deletelocationbyid","routeSlug":"/apis/order-book/order-book-api/locations/deletelocationbyid","metadata":{"seo":{"title":"Delete a location with specified business id.\n","description":"This endpoint allows you to delete a location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLocationById","name":"Delete a location with specified business id.\n","isWebhook":false,"pointer":"/paths/~1locations~1{business_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a location with specified business id.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to delete a location.\n\nLocations can only be deleted if they are no longer in use by future orders or conditionals.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1locations~1{business_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1locations~1{business_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/locations/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","404","409","default"],"pointer":"/locations/{business_id}","href":"locations/deletelocationbyid","openApiOperationId":"deleteLocationById","summary":"Delete a location with specified business id.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deletion has succeeded, but body is empty"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","description":"Response status code indicates a request conflict with current state of the server.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1locations~1{business_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/locations/{business_id}"}],"content":{"contentType":"group","meta":{"name":"locations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Locations","showPageActions":true},{"nodeType":"markdoc","content":"Locations can be managed separately in Order Book, which allows the user to capture their related business rules in a reusable manner. This is especially valuable \nin business cases where a select set of Locations is reused across many orders. \n\nTypical use cases include capturing regular opening hours or requirements tied to a specific Location."},{"nodeType":"external-docs","url":"https://developer.conundra.eu/developer-portal/order-book/domain/#location","description":"Find out more"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/locations","summary":"Get a list of all locations by ids","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locations/getpagedlocations","deprecated":false},{"title":"/locations/by","summary":"Get a list of locations by filter criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locations/getpagedlocationsby","deprecated":false},{"title":"/locations/{business_id}","summary":"Get a location with specified business Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locations/getlocationbyid","deprecated":false},{"title":"/locations/{business_id}","summary":"Upsert a location with specified business Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/locations/upsertlocationbyid","deprecated":false},{"title":"/locations/{business_id}","summary":"Delete a location with specified business id.\n","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/locations/deletelocationbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Conditionals","link":"/apis/order-book/order-book-api/conditionals","routeSlug":"/apis/order-book/order-book-api/conditionals","items":[{"label":"Create a new conditional","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/conditionals/createconditional","routeSlug":"/apis/order-book/order-book-api/conditionals/createconditional","metadata":{"seo":{"title":"Create a new conditional","description":"This endpoint allows you to create a new conditional. The application will assign a generated ID to the conditional, that can be used for retrieving, updatingor deleting the conditional. This generated ID is returned in the Location header and (optional) response body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createConditional","name":"Create a new conditional","isWebhook":false,"pointer":"/paths/~1conditionals/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new conditional","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to create a new conditional. The application will assign a generated ID to the conditional, that can be used for retrieving, updating"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or deleting the conditional. This generated ID is returned in the Location header and ("},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") response body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status codes 200 or 201 with the resource in the response body on success (representation)."},"children":[]}]}]}]}]}],"pointer":"/paths/~1conditionals/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Conditional"}},"schemaId":"components/schemas/Conditional","pointer":"/paths/~1conditionals/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/conditionals","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","schemaId":"schema_51"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Conditional"}},"responseCodes":["201","204","default"],"pointer":"/conditionals","href":"conditionals/createconditional","openApiOperationId":"createConditional","summary":"Create a new conditional"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/Conditional","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Conditional"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conditional"}},"schemaId":"components/schemas/Conditional","headers":{"Location":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contains the URI, including the ID of the created conditional ex /conditional/{id}"},"children":[]}]}]}]},"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_63"},{"code":"204","description":"Created successfully","headers":{"Location":{"schema":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contains the URI, including the ID of the created conditional ex /conditional/{id}"},"children":[]}]}]}]},"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_63"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1conditionals/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Conditional","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conditional"}}},{"code":"204"},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/conditionals"},{"label":"Get a conditional by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/conditionals/getconditionalbyid","routeSlug":"/apis/order-book/order-book-api/conditionals/getconditionalbyid","metadata":{"seo":{"title":"Get a conditional by Id","description":"This endpoint allows you to get the information about a given conditional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConditionalById","name":"Get a conditional by Id","isWebhook":false,"pointer":"/paths/~1conditionals~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a conditional by Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to get the information about a given conditional.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_47","description":"The generated identifier of an entity instance","required":true}],"pointer":"/paths/~1conditionals~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/conditionals/{id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/conditionals/{id}","href":"conditionals/getconditionalbyid","openApiOperationId":"getConditionalById","summary":"Get a conditional by Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conditional"}},"schemaId":"components/schemas/Conditional","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_50"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1conditionals~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Conditional","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conditional"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/conditionals/{id}"},{"label":"Update an existing conditional by Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/conditionals/updateconditionalbyid","routeSlug":"/apis/order-book/order-book-api/conditionals/updateconditionalbyid","metadata":{"seo":{"title":"Update an existing conditional by Id","description":"This endpoint updates a given conditional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateConditionalById","name":"Update an existing conditional by Id","isWebhook":false,"pointer":"/paths/~1conditionals~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing conditional by Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint updates a given conditional.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_47","description":"The generated identifier of an entity instance","required":true}],"pointer":"/paths/~1conditionals~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status codes 200 or 201 with the resource in the response body on success (representation)."},"children":[]}]}]}]}]},{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1conditionals~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/Conditional"}},"schemaId":"components/schemas/Conditional","pointer":"/paths/~1conditionals~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/conditionals/{id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","schemaId":"schema_51"},{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Conditional"}},"responseCodes":["200","204","404","412","default"],"pointer":"/conditionals/{id}","href":"conditionals/updateconditionalbyid","openApiOperationId":"updateConditionalById","summary":"Update an existing conditional by Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/Conditional","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Conditional"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conditional"}},"schemaId":"components/schemas/Conditional","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_52"},{"code":"204","description":"Created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"}},"headerSchemaId":"schema_52"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1conditionals~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Conditional","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conditional"}}},{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/conditionals/{id}"},{"label":"Delete a conditional by Id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/conditionals/deleteconditionalbyid","routeSlug":"/apis/order-book/order-book-api/conditionals/deleteconditionalbyid","metadata":{"seo":{"title":"Delete a conditional by Id","description":"This endpoint allows you to delete a given conditional"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteConditionalById","name":"Delete a conditional by Id","isWebhook":false,"pointer":"/paths/~1conditionals~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a conditional by Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to delete a given conditional\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_47","description":"The generated identifier of an entity instance","required":true}],"pointer":"/paths/~1conditionals~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1conditionals~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/conditionals/{id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","404","412","default"],"pointer":"/conditionals/{id}","href":"conditionals/deleteconditionalbyid","openApiOperationId":"deleteConditionalById","summary":"Delete a conditional by Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deletion has succeeded and body is empty\n"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1conditionals~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/conditionals/{id}"}],"content":{"contentType":"group","meta":{"name":"conditionals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conditionals","showPageActions":true},{"nodeType":"markdoc","content":"Conditionals allow you to capture business rules in Order Book. You can target Orders based on several attributes or create time-based rules, and apply mutations to this order set enriching for your optimization."},{"nodeType":"external-docs","url":"https://developer.conundra.eu/developer-portal/order-book/domain/#consolidation","description":"Find out more"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/conditionals","summary":"Create a new conditional","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conditionals/createconditional","deprecated":false},{"title":"/conditionals/{id}","summary":"Get a conditional by Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conditionals/getconditionalbyid","deprecated":false},{"title":"/conditionals/{id}","summary":"Update an existing conditional by Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conditionals/updateconditionalbyid","deprecated":false},{"title":"/conditionals/{id}","summary":"Delete a conditional by Id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/conditionals/deleteconditionalbyid","deprecated":false}]}]}]}]}},{"type":"separator","label":"Preplanned","content":null},{"type":"group","label":"Partial Routes [EXPERIMENTAL]","link":"/apis/order-book/order-book-api/partial-routes","routeSlug":"/apis/order-book/order-book-api/partial-routes","items":[{"label":"[EXPERIMENTAL] Get a cursor-paged list of preplanned partial routes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/partial-routes/getpreplannedpartialroutes","routeSlug":"/apis/order-book/order-book-api/partial-routes/getpreplannedpartialroutes","metadata":{"seo":{"title":"[EXPERIMENTAL] Get a cursor-paged list of preplanned partial routes","description":"[EXPERIMENTAL] Retrieve a cursor-paged list of all preplanned partial routes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPreplannedPartialRoutes","name":"[EXPERIMENTAL] Get a cursor-paged list of preplanned partial routes","isWebhook":false,"pointer":"/paths/~1preplanned~1partial-routes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get a cursor-paged list of preplanned partial routes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retrieve a cursor-paged list of all preplanned partial routes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can find out more about how to use cursors in our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.conundra.eu/developer-portal/cursor-paging/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"developer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor of the page to retrieve. Can be left blank initially to retrieve the first page. Paging through the results requires passing in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from a previous response."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_48","description":"Number of results per page."}],"pointer":"/paths/~1preplanned~1partial-routes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/preplanned/partial-routes","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","schemaId":"schema_47"},{"name":"limit","in":"query","schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/preplanned/partial-routes","href":"partial-routes/getpreplannedpartialroutes","openApiOperationId":"getPreplannedPartialRoutes","summary":"[EXPERIMENTAL] Get a cursor-paged list of preplanned partial routes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A cursor-based paged set of preplanned partial routes. The set might be empty if no routes are present.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagePreplannedPartialRoutes"}},"schemaId":"components/schemas/CursorPagePreplannedPartialRoutes"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1preplanned~1partial-routes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPagePreplannedPartialRoutes","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagePreplannedPartialRoutes"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/preplanned/partial-routes"},{"label":"[EXPERIMENTAL] Upsert PartialRoute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/partial-routes/upsertpartialroute","routeSlug":"/apis/order-book/order-book-api/partial-routes/upsertpartialroute","metadata":{"seo":{"title":"[EXPERIMENTAL] Upsert PartialRoute","description":"[EXPERIMENTAL] Upsert a PartialRoute defined by a business id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertPartialRoute","name":"[EXPERIMENTAL] Upsert PartialRoute","isWebhook":false,"pointer":"/paths/~1preplanned~1partial-routes~1{business_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Upsert PartialRoute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Upsert a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defined by a business id."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1preplanned~1partial-routes~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1preplanned~1partial-routes~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PartialRoute"}},"schemaId":"components/schemas/PartialRoute","pointer":"/paths/~1preplanned~1partial-routes~1{business_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/preplanned/partial-routes/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PartialRoute"}},"responseCodes":["201","204","404","412","default"],"pointer":"/preplanned/partial-routes/{business_id}","href":"partial-routes/upsertpartialroute","openApiOperationId":"upsertPartialRoute","summary":"[EXPERIMENTAL] Upsert PartialRoute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"schemaId":"components/schemas/PartialRoute","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PartialRoute"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created or updated, when the Prefer header was set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return=representation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartialRoute"}},"schemaId":"components/schemas/PartialRoute","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_64"},{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created or updated, when the Prefer header was set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return=minimal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_64"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"default","description":"General error payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1preplanned~1partial-routes~1{business_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PartialRoute","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartialRoute"}}},{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"default","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/preplanned/partial-routes/{business_id}"},{"label":"[EXPERIMENTAL] Get PartialRoute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/partial-routes/getpartialroute","routeSlug":"/apis/order-book/order-book-api/partial-routes/getpartialroute","metadata":{"seo":{"title":"[EXPERIMENTAL] Get PartialRoute","description":"[EXPERIMENTAL] Get a PartialRoute by a business id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPartialRoute","name":"[EXPERIMENTAL] Get PartialRoute","isWebhook":false,"pointer":"/paths/~1preplanned~1partial-routes~1{business_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get PartialRoute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Get a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by a business id."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1preplanned~1partial-routes~1{business_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/preplanned/partial-routes/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/preplanned/partial-routes/{business_id}","href":"partial-routes/getpartialroute","openApiOperationId":"getPartialRoute","summary":"[EXPERIMENTAL] Get PartialRoute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartialRoute"}},"schemaId":"components/schemas/PartialRoute","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_50"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1preplanned~1partial-routes~1{business_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PartialRoute","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartialRoute"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/preplanned/partial-routes/{business_id}"},{"label":"[EXPERIMENTAL] Delete PartialRoute","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/order-book/order-book-api/partial-routes/deletepartialroute","routeSlug":"/apis/order-book/order-book-api/partial-routes/deletepartialroute","metadata":{"seo":{"title":"[EXPERIMENTAL] Delete PartialRoute","description":"[EXPERIMENTAL] Delete a PartialRoute by a business id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePartialRoute","name":"[EXPERIMENTAL] Delete PartialRoute","isWebhook":false,"pointer":"/paths/~1preplanned~1partial-routes~1{business_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Delete PartialRoute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Delete a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by a business id."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"business_id","in":"path","schemaId":"schema_49","description":"The business identifier of an entity instance","required":true}],"pointer":"/paths/~1preplanned~1partial-routes~1{business_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_47","description":"weak Etag as optimistic locking check"}],"pointer":"/paths/~1preplanned~1partial-routes~1{business_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/preplanned/partial-routes/{business_id}","servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_47"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","404","412"],"pointer":"/preplanned/partial-routes/{business_id}","href":"partial-routes/deletepartialroute","openApiOperationId":"deletePartialRoute","summary":"[EXPERIMENTAL] Delete PartialRoute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/order-book/order-book-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deletion has succeeded and body is empty"},{"code":"404","description":"The entity is not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET \nor HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the \nentity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed \nand this error response is sent back.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1preplanned~1partial-routes~1{business_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/preplanned/partial-routes/{business_id}"}],"content":{"contentType":"group","meta":{"name":"partial routes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partial Routes [EXPERIMENTAL]","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[UNDER DEVELOPMENT]"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints for managing preplanned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoutes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/preplanned/partial-routes","summary":"[EXPERIMENTAL] Get a cursor-paged list of preplanned partial routes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/partial-routes/getpreplannedpartialroutes","deprecated":false},{"title":"/preplanned/partial-routes/{business_id}","summary":"[EXPERIMENTAL] Upsert PartialRoute","prefix":{"name":"put","color":"put"},"badges":[],"link":"/partial-routes/upsertpartialroute","deprecated":false},{"title":"/preplanned/partial-routes/{business_id}","summary":"[EXPERIMENTAL] Get PartialRoute","prefix":{"name":"get","color":"get"},"badges":[],"link":"/partial-routes/getpartialroute","deprecated":false},{"title":"/preplanned/partial-routes/{business_id}","summary":"[EXPERIMENTAL] Delete PartialRoute","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/partial-routes/deletepartialroute","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/BulkLocationResponse":{"id":"components/schemas/BulkLocationResponse","kind":"json-schema","title":"BulkLocationResponse","data":{"type":"object","properties":{"data":{"type":"array","minItems":0,"maxItems":100,"uniqueItems":true,"items":{"$ref":"#/components/schemas/Location"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Problem"}}}}},"components/schemas/BulkTransportRequestResponse":{"id":"components/schemas/BulkTransportRequestResponse","kind":"json-schema","title":"BulkTransportRequestResponse","data":{"type":"object","properties":{"data":{"type":"array","minItems":0,"maxItems":100,"uniqueItems":true,"items":{"$ref":"#/components/schemas/TransportRequest"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Problem"}}}}},"components/schemas/Capacity":{"id":"components/schemas/Capacity","kind":"json-schema","title":"Capacity","data":{"title":"Capacity","type":"object","description":"Required capacity on the executor of this Order.\n","properties":{"type":{"type":"string","enum":["volume","weight","loadingMeters","capacity1","capacity2","capacity3","capacity4","capacity5"],"description":"Characterization of a capacity, representing the dimension in which this Capacity is expressed.\n","default":"volume"},"value":{"type":"number","format":"double","exclusiveMinimum":0,"example":20,"description":"The nominal capacity required of the executor, in the specified dimension.\n"},"description":{"type":"string","description":"An optional description for this capacity entry.\n"}},"required":["value"]}},"components/schemas/ClosedDateRange":{"id":"components/schemas/ClosedDateRange","kind":"json-schema","title":"ClosedDateRange","data":{"description":"Specifies a closed interval with 2 absolute dates\n","type":"object","properties":{"start_at":{"type":"string","description":"The ISO-8601 formatted start date of the interval.\n","format":"date-time","example":"2021-01-01T10:15:30Z"},"end_at":{"type":"string","description":"The ISO-8601 formatted end date of the interval.\n","format":"date-time","example":"2021-01-01T10:15:30Z"}},"required":["start_at","end_at"]}},"components/schemas/Company":{"id":"components/schemas/Company","kind":"json-schema","title":"Company","data":{"type":"object","properties":{"business_id":{"description":"A unique reference ID","type":"string","pattern":"^[a-zA-Z0-9.~\\-_]+$","example":"624ec196-4c5c-4fb4-bb43-9ffd8a6b8844"},"name":{"description":"The name of this Company","type":"string","example":"a name"}}}},"components/schemas/Conditional":{"id":"components/schemas/Conditional","kind":"json-schema","title":"Conditional","data":{"description":"Conditionals capture business rules that need to be applied to subsets of orders when they adhere to certain conditions.\n","type":"object","properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A generated identifier for a conditional. The identifier is returned in both the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and (optional) response body when creating the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional."},"children":[]}]}]}],"type":"string","example":"624ec196-4c5c-4fb4-bb43-9ffd8a6b8844","readOnly":true},"name":{"description":"A short name for the Conditional","type":"string","example":"a name"},"description":{"type":"string","example":"a description","description":"A description for the conditional, helpful in determining the why or what."},"conditions":{"type":"object","description":"The rules that will determine whether this conditional is applicable to an order or not.\n\nAt least one conditional needs to be provided. The different top-level conditions are combined with AND logic, ie: they all need to match for an order\nto match this conditional.\n","properties":{"locations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this condition to target orders based on their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"site_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", by providing the Location's business ID in the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When providing multiple references, only one of the Locations needs to be present on the Order."},"children":[]}]}]}],"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A business_id of a known Location"},"children":[]}]}]}],"type":"string","example":"locationA"}},"temporals":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a time-based condition for targeting orders. Each temporal condition provided will look for orders where at least one timeFrame (either"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"absolute or windowed) overlaps with this range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should the order contain timeframes without an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the default period of two weeks will be used to determine whether the timeframe overlaps"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the temporal condition."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When providing multiple temporal conditions, only one of them needs to match the order's timeframe."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ClosedDateRange"}},"categories":{"type":"array","description":"When providing filters on categories of multiple types, each type needs to match for an order to match the condition.\n","items":{"$ref":"#/components/schemas/ConditionsCategory"}},"clients":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of references to Companies (identified by their business id). When any company is present on an order's ("},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") transport request, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order matches the condition."},"children":[]}]}]}],"items":{"type":"string","example":"company-id"}}}},"effects":{"type":"object","description":"At least one property has to be filled.","properties":{"stop_time":{"$ref":"#/components/schemas/IsoDuration"},"time_windows":{"type":"array","minItems":0,"maxItems":100,"uniqueItems":true,"items":{"$ref":"#/components/schemas/TimeWindow"}},"requirements":{"$ref":"#/components/schemas/Requirements"}}}},"required":["conditions","effects"]}},"components/schemas/ConditionsCategory":{"id":"components/schemas/ConditionsCategory","kind":"json-schema","title":"ConditionsCategory","data":{"type":"object","properties":{"entity_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entity type for which this category needs to be present. within a conditional, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORDER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entities are supported. When using the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entity type, all orders linked to this location will be targeted."},"children":[]}]}]}],"$ref":"#/components/schemas/EntityType"},"categories":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of categories (defined by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), of which one needs to be present on the specified entity for the order to match."},"children":[]}]}]}],"minItems":1,"items":{"type":"string","example":"my-category"}}},"required":["entity_type","categories"]}},"components/schemas/CountryCode":{"id":"components/schemas/CountryCode","kind":"json-schema","title":"CountryCode","data":{"description":"An ISO3166-1 alpha-2 two letter country code","type":"string","pattern":"^[A-Z]{2}$","example":"BE"}},"components/schemas/Cursor":{"id":"components/schemas/Cursor","kind":"json-schema","title":"Cursor","data":{"type":"object","properties":{"self":{"type":"string","description":"The cursor for this page. Not present when the result contains no data.","example":"c2VsZl9fcGFnZQ"},"prev":{"type":"string","description":"The cursor for the previous page. Not present when fetching data for the first page.","example":"cHJldmlvdXNfX3BhZ2U"},"next":{"type":"string","description":"The cursor for the next page. Not present when fetching data for the last page.","example":"bmV4dF9fcGFnZQ"}}}},"components/schemas/CursorPageTransportRequests":{"id":"components/schemas/CursorPageTransportRequests","kind":"json-schema","title":"CursorPageTransportRequests","data":{"type":"object","properties":{"data":{"type":"array","description":"Subset of Transport Requests matching the provided query, limited to the size specified in the request.\n","items":{"$ref":"#/components/schemas/TransportRequest"}},"cursor":{"$ref":"#/components/schemas/Cursor"}},"required":["data","cursor"]}},"components/schemas/CustomData":{"id":"components/schemas/CustomData","kind":"json-schema","title":"CustomData","data":{"title":"CustomData","description":"Custom data is an extendable hashmap of key-value pairs for client usage. These values have no meaning in the context of Order Book, but can be used to \nenrich the data in Order Book with relevant information for the end users.\n\nA maximum of 100 entries is allowed.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single key-value pair, with the value being an optional string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The platform distinguishes between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values (there is no value for this key) and empty values (the value of this key is an empty string: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When setting the value of a custom data property to an empty string, the key will still be present on an order in an Optiflow Match planning (for relevant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"entities), whereas setting the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" signifies that this key is not a part of this entity."},"children":[]}]}]}]},"example":{"shop_manager":"John Smith"}}},"components/schemas/DayOfWeek":{"id":"components/schemas/DayOfWeek","kind":"json-schema","title":"DayOfWeek","data":{"description":"Corresponding to the days of the week, starting on Monday.\n","type":"string","example":"MONDAY","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"components/schemas/DeliveryInTransportRequest":{"id":"components/schemas/DeliveryInTransportRequest","kind":"json-schema","title":"Delivery","data":{"title":"Delivery","description":"A single delivery order.\n","type":"object","properties":{"order":{"$ref":"#/components/schemas/OrderInformationInTransportRequest"},"delivery":{"$ref":"#/components/schemas/TransportInformation"}},"required":["order","delivery"]}},"components/schemas/ConsolidatedOrders":{"id":"components/schemas/ConsolidatedOrders","kind":"json-schema","title":"ConsolidatedOrders","data":{"type":"object","properties":{"data":{"type":"array","minItems":0,"maxItems":100,"uniqueItems":true,"items":{"$ref":"#/components/schemas/ConsolidatedOrder"}},"cursor":{"$ref":"#/components/schemas/Cursor"}},"required":["data","cursor"]}},"components/schemas/ConsolidatedOrder":{"id":"components/schemas/ConsolidatedOrder","kind":"json-schema","title":"Consolidated Order","data":{"title":"Consolidated Order","description":"Information on a consolidated order.\n","type":"object","properties":{"order_id":{"type":"string","description":"The unique identifier of an order"},"transport_request_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(optional)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transport request related to the order"},"children":[]}]}]}]},"order_type":{"type":"string","description":"The type of the Order.\n","enum":["PICKUP","DELIVERY","PICKUP_DELIVERY"]},"unplannable_reasons":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code indicating why an order is inherently unplannable. We keep these codes stable, so they can be used by automated integrations."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_PLANNABLE_TIME_WINDOWS_FOR_PICKUP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_PLANNABLE_TIME_WINDOWS_FOR_DELIVERY"},"children":[]}]}]}]}]},"description":{"type":"string","description":"Human-friendly description of the cause for the unplannability.\n"}}}}}}},"components/schemas/EntityCategory":{"id":"components/schemas/EntityCategory","kind":"json-schema","title":"EntityType","data":{"title":"EntityType","type":"object","properties":{"entity":{"type":"string","enum":["order","location","transport-request"],"description":"The entity type for which this category is valid.","example":"location","readOnly":true},"code":{"type":"string","description":"A unique code for this category, within the entity's categories.","example":"codeA","readOnly":true},"labels":{"description":"Descriptive labels for this category.\n","$ref":"#/components/schemas/MultiLanguages"}},"required":["code","labels"]}},"components/schemas/EntityCategories":{"id":"components/schemas/EntityCategories","kind":"json-schema","title":"EntityCategories","data":{"type":"object","properties":{"data":{"type":"array","minItems":0,"maxItems":100,"uniqueItems":true,"items":{"$ref":"#/components/schemas/EntityCategory"}},"page":{"$ref":"#/components/schemas/Paging"}}}},"components/schemas/EntityType":{"id":"components/schemas/EntityType","kind":"json-schema","title":"EntityType","data":{"type":"string","example":"LOCATION","x-extensible-enum":["LOCATION","TRANSPORT_REQUEST","ORDER"]}},"components/schemas/Etag":{"id":"components/schemas/Etag","kind":"json-schema","title":"Etag","data":{"type":"string","example":"W/\"1\"","description":"Must match header if provided on request."}},"components/schemas/GeoPoint":{"id":"components/schemas/GeoPoint","kind":"json-schema","title":"GeoPoint","data":{"properties":{"latitude":{"type":"number","format":"double","example":50.9514048},"longitude":{"type":"number","format":"double","example":3.8067878}},"required":["latitude","longitude"]}},"components/schemas/GeoAddress":{"id":"components/schemas/GeoAddress","kind":"json-schema","title":"GeoAddress","data":{"type":"object","description":"Either a textual address information should be present, or a geo point. The resolved information is read only and will be filled out after resolving, \nie: it is only visible in the response.\n","properties":{"address_line":{"type":"string","example":"Voordries 41","description":"Optional address line representing the street address (optionally including house number, box, ...)"},"city":{"type":"string","example":"Oosterzele","description":"The name of the locality. Mandatory if no geo point is provided."},"zip_code":{"type":"string","example":"9860","description":"The uniquely identifying code of this locality. Mandatory if no geo point is provided."},"country_code":{"description":"An ISO3166-1 alpha-2 two letter country code. Mandatory if no geo point is provided.","$ref":"#/components/schemas/CountryCode"},"geo_point":{"$ref":"#/components/schemas/GeoPoint","description":"A The geo point is optional, if and only if all the mandatory address fields are supplied. When no geo point is provided, a geocoding call will determine\nthe geo point using the provided textual address fields. (See resolved address for more information.)\n\nAdding a geo point allows you to retain full control of the data that will be used in your planning.\n"},"resolved_address":{"$ref":"#/components/schemas/ResolvedAddress"}}}},"components/schemas/Location":{"id":"components/schemas/Location","kind":"json-schema","title":"Location","data":{"title":"Location","description":"A location has an address and timewindows representing opening hours.\n\nAn alternative address and/or timewindows to be used for planning can be specified.\nWhen planning address and/or timewindows are specified the originals are only there for information purposes.\n\nAn address item can consist of an address and/or geo coordinates.\nThe resolved version will be resolved based on the geo coordinates or the address (not both).\nThe resolved version will be available when reading to make out what the original geo coordinates in the routing service are.\n","type":"object","properties":{"business_id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,512}$","example":"locationA","description":"Unique reference id"},"location_category":{"type":"string","minLength":1,"pattern":"^\\S.*","example":"locationCategoryA","description":"An optional category for the Locations, represented by its code. Defining a category for your Location can help in easy retrieval of the information \nthrough the search-endpoints or in the user interface.\n\nA category will also allow you to target Conditionals to Orders which are tied to a Location with specific categories.\n\nWhen provided, the value must not be blank.\n"},"name":{"type":"string","example":"locationName","description":"An optional name that helps in identifying the Location.\n"},"description":{"type":"string","example":"locationDescription","description":"A freeform text description of the Location, providing additional details that might be of use for a planner.\n"},"comment":{"type":"string","example":"locationComment","description":"A freeform text field for adding comments to a Location.\n"},"address":{"description":"The main, physical address for this Location. This address as mandatory for creating/updating a Location.\n","$ref":"#/components/schemas/GeoAddress"},"planning_address":{"description":"The planning address allows you to override the address on a Location. A typical use case for this would be to provide the official address of a retail\nlocation in the address field, but specifying a loading dock in a back alley using the planning address.\n","$ref":"#/components/schemas/GeoAddress"},"stop_time":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The stop time to be applied when visiting this Location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be specified as a valid ISO Duration (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601#Durations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wikipedia ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC-3339"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Must be non negative."},"children":[]}]}]}],"$ref":"#/components/schemas/IsoDuration"},"requirements":{"$ref":"#/components/schemas/Requirements"},"time_window":{"$ref":"#/components/schemas/TimeWindows"},"planning_time_window":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Planning time windows allow you to specify a different set of time windows for use in the planning, and follow the same format as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_window"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A typical use case for this would be to specify different delivery windows for a retail location (eg: you can deliver order before the regular opening hours"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the retail location) while still providing the information about the regular opening hours (eg: a planner can still determine whether he would be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"able to contact anyone at the location during their regular opening hours)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no planning time windows are specified, the regular time windows will be used for planning."},"children":[]}]}]}],"$ref":"#/components/schemas/TimeWindows"},"custom_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom data allows you te enrich a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with relevant information for the planner that is not part of the Order Book domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Data on a Location will be inherited by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" linked to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When a key is duplicated on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will retain its value for this key."},"children":[]}]}]}],"$ref":"#/components/schemas/CustomData"},"ignore_consecutive_restrictions":{"type":"boolean","description":"When set to true, consecutive visit restrictions will be ignored for this Location during planning.\n"},"labels":{"type":"array","maxItems":100,"default":[],"items":{"type":"string","example":"STORE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used for identifying sets of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When defining rules in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Plan Profiles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can target sets of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by referencing their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a label contains a dash, it will be split into two upon exporting and re-importing the order set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"pattern":"^[a-zA-Z0-9.~\\-_]{1,200}$"}},"etag":{"$ref":"#/components/schemas/Etag"}},"required":["address","business_id"]}},"components/schemas/LocationId":{"id":"components/schemas/LocationId","kind":"json-schema","title":"LocationId","data":{"type":"object","properties":{"location_id":{"type":"string","example":"locationA","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a known "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/Locations":{"id":"components/schemas/Locations","kind":"json-schema","title":"Locations","data":{"type":"object","properties":{"data":{"type":"array","minItems":0,"maxItems":100,"uniqueItems":true,"items":{"$ref":"#/components/schemas/Location"}},"page":{"$ref":"#/components/schemas/Paging"}}}},"components/schemas/MultiLanguages":{"id":"components/schemas/MultiLanguages","kind":"json-schema","title":"MultiLanguages","data":{"properties":{"languages":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key must be a valid "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-639-language-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 639-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" language code."},"children":[]}]}]}],"type":"object","additionalProperties":{"type":"string","description":"The value represents the label to be used for the language code specified by the key."}},"default_label":{"type":"string","example":"low emission zone","description":"label for the default language to fall back on"}},"required":["default_label"],"example":{"default_label":"low emission zone","languages":{"nl":"lage emissie zone","fr":"zone à faible émission"}}}},"components/schemas/WindowedTimeFrame":{"id":"components/schemas/WindowedTimeFrame","kind":"json-schema","title":"WindowedTimeFrame","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a datetime interval within which an Order's activity "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be executed."},"children":[]}]}]}],"type":"object","properties":{"start_at":{"type":"string","description":"The start of the datetime interval, provided as an ISO-8601 formatted datetime.\n","format":"date-time","example":"2021-01-01T10:15:30Z"},"end_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end of the datetime interval, provided as an ISO-8601 formatted datetime."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the value is defaulted to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + 14 days."},"children":[]}]}]}],"format":"date-time","example":"2021-01-01T10:15:30Z"}},"required":["start_at"]}},"components/schemas/AbsoluteTimeFrame":{"id":"components/schemas/AbsoluteTimeFrame","kind":"json-schema","title":"AbsoluteTimeFrame","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a datetime interval within which an Order's activity "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be executed."},"children":[]}]}]}],"type":"object","properties":{"start_at":{"type":"string","description":"The start of the datetime interval, provided as an ISO-8601 formatted datetime.\n","format":"date-time","example":"2021-01-01T10:15:30Z"},"end_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end of the datetime interval, provided as an ISO-8601 formatted datetime."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the value is defaulted to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + 14 days."},"children":[]}]}]}],"format":"date-time","example":"2021-01-01T10:15:30Z"},"cost":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional cost for executing the activity within this datetime interval. This (potentially fictional) cost can be used to steer the optimization. A"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"higher cost will be less likely to result in this interval being chosen, though this is still possible if it leads to an overall lower cost on of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optimization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It's recommended to use integer values as decimal precision is not guaranteed."},"children":[]}]}]}],"type":"number","format":"double","example":42}},"required":["start_at"]}},"components/schemas/OrderInformation":{"id":"components/schemas/OrderInformation","kind":"json-schema","title":"OrderInformation","data":{"type":"object","properties":{"business_id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,512}$","example":"orderA","readOnly":true,"description":"A unique reference id.\n"},"order_category":{"type":"string","example":"orderCategoryA","description":"An optional category for the Order, represented by its code. Defining a category for your Order can help in easy retrieval of the information in the user interface.\n\nConditionals can be targeted to Orders with a specific category, allowing the planner to create business rules for sets of Orders.\n"},"description":{"type":"string","example":"a description","description":"A freeform text description, providing additional details that might be of use for a planner.\n"},"capacities":{"type":"array","minItems":1,"maxItems":8,"uniqueItems":true,"description":"Required capacity on the executor of this Order. The executor will need to be able to fulfill all capacities specified on this Order in order to execute\nit.\n","items":{"$ref":"#/components/schemas/Capacity"}},"mandatory":{"type":"boolean","example":true,"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean flag signaling the optimization that this order "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be executed. If this flag is not provided the order is considered optional and an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outsourcing_cost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" needs to be provided."},"children":[]}]}]}]},"requirements":{"$ref":"#/components/schemas/OrderRequirements"},"lifo_groups":{"type":"array","maxItems":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders are handled "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last-in, first-out"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (LIFO) within an optimization. Specifying LIFO-groups will limit this behaviour to only those orders within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same LIFO group."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An order can be a part of multiple LIFO groups, which will result in the LIFO-constraint being applied within each LIFO group it is a part of."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a lifo group contains a dash, it will be split into two upon exporting and re-importing the order set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"items":{"type":"string","maxLength":200,"example":"lifo_group"}},"outsourcing_cost":{"type":"number","format":"double","example":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fictional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cost for not planning this order in an optimization. This allows the optimization engine to weigh the costs of executing the order versus"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outsourcing it to a ("},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"potentially fictitious"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") third party."},"children":[]}]}]}]},"custom_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom data allows you te enrich an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with relevant information for the planner that is not part of the Order Book domain. Custom data properties"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be available on the distinct activities ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pickup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the planning context. This allows you to define a property"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"once and have it available on both parts of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PickupDelivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a custom data key is duplicated on the activity-level, it will override the value defined on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" level."},"children":[]}]}]}],"$ref":"#/components/schemas/CustomData"},"plan_group":{"type":"string","example":"a plan group","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The plan group this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to. Plan groups signify the group of orders that are supposed to be planned together."},"children":[]}]}]}]},"client":{"type":"string","example":"companyId","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional reference, by business_id, to a Company that is known in Order Book. Conditionals can target Orders"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a certain Company as its client, thus providing the planner a way for applying business rules to all Orders for certain customers."},"children":[]}]}]}]},"max_time_in_vehicle":{"$ref":"#/components/schemas/MaxTimeInVehicle"}},"required":["capacities"]}},"components/schemas/OrderInformationInTransportRequest":{"id":"components/schemas/OrderInformationInTransportRequest","kind":"json-schema","title":"OrderInformationInTransportRequest","data":{"type":"object","description":"General order properties. In case of a pickupDelivery Order, these properties are shared between both the pickup and delivery activities.\n","properties":{"business_id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,512}$","example":"orderA","description":"A unique reference id.\n"},"order_category":{"type":"string","example":"orderCategoryA","description":"An optional category for the Order, represented by its code. Defining a category for your Order can help in easy retrieval of the information in the user interface.\n\nConditionals can be targeted to Orders with a specific category, allowing the planner to create business rules for sets of Orders.\n"},"description":{"type":"string","example":"a description","description":"A freeform text description, providing additional details that might be of use for a planner.\n"},"capacities":{"type":"array","minItems":1,"maxItems":8,"uniqueItems":true,"description":"Required capacity on the executor of this Order. The executor will need to be able to fulfill all capacities specified on this Order in order to execute\nit.\n","items":{"$ref":"#/components/schemas/Capacity"}},"mandatory":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean flag signaling the optimization that this order "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be executed. If this flag is not provided, an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outsourcing_cost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" needs to be provided."},"children":[]}]}]}]},"requirements":{"$ref":"#/components/schemas/OrderRequirements"},"lifo_groups":{"type":"array","maxItems":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders are handled "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last-in, first-out"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (LIFO) within an optimization. Specifying LIFO-groups will limit this behaviour to only those orders within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same LIFO group."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An order can be a part of multiple LIFO groups, which will result in the LIFO-constraint being applied within each LIFO group it is a part of."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a lifo group contains a dash, it will be split into two upon exporting and re-importing the order set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"items":{"type":"string","maxLength":200,"example":"lifo_group"}},"outsourcing_cost":{"type":"number","format":"double","example":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fictional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cost for not planning this order in an optimization. This allows the optimization engine to weigh the costs of executing the order versus"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outsourcing it to a ("},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"potentially fictitious"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") third party."},"children":[]}]}]}]},"custom_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom data allows you te enrich an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with relevant information for the planner that is not part of the Order Book domain. Custom data properties"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be available on the distinct activities ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pickup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the planning context. This allows you to define a property"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"once and have it available on both parts of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PickupDelivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a custom data key is duplicated on the activity-level, it will override the value defined on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" level."},"children":[]}]}]}],"$ref":"#/components/schemas/CustomData"},"plan_group":{"type":"string","example":"a plan group","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The plan group this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to. Plan groups signify the group of orders that are supposed to be planned together."},"children":[]}]}]}]},"max_time_in_vehicle":{"$ref":"#/components/schemas/MaxTimeInVehicle"},"client":{"type":"string","example":"companyId","readOnly":true,"description":"The client of the Transport Request this Order belongs to, if any. This is a read-only field inherited from the parent Transport Request.\n"}},"required":["business_id","capacities"]}},"components/schemas/OrderRequirements":{"id":"components/schemas/OrderRequirements","kind":"json-schema","title":"OrderRequirements","data":{"type":"object","description":"Requirements and constraints that this order enforces of its executor. These properties help the optimization engine in determining which executors could\nbe used for this Order.\n","properties":{"tags":{"type":"array","maxItems":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Properties that "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be present on the executor to be allowed to execute this order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a tag contains a dash, it will be split into two upon exporting and re-importing the order set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"items":{"type":"string","maxLength":200,"example":"tagX"}},"forbidden_tags":{"type":"array","maxItems":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Properties that "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be present on the executor to be allowed to execute this order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a forbidden tag contains a dash, it will be split into two upon exporting and re-importing the order set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"items":{"type":"string","maxLength":200,"example":"tagY"}},"combination_strategy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strategy for combining the requirements and constraints of this Order with those on linked Locations or applicable Conditionals."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The strategies have the following consequences:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OVERRIDE"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order takes precedence over both Conditionals and Locations, only the Order's requirements and constraints will be taken into account for the optimization."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMBINE"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order's requirements and constraints will be combined with all requirements and constraints on the linked Location and applicable Conditionals."},"children":[]}]}]}]}],"enum":["COMBINE","OVERRIDE"],"default":"COMBINE"}}}},"components/schemas/Orders":{"id":"components/schemas/Orders","kind":"json-schema","title":"Orders","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders contain all orders related to a TransportRequest. Due to de difference in optimization, the orders can contain either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pickupAndDeliveries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"separate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pickups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"deliveries":{"type":"array","minItems":0,"maxItems":100,"uniqueItems":true,"description":"Set of deliveries related to this Transport Request.\n","items":{"$ref":"#/components/schemas/DeliveryInTransportRequest"}},"pickups":{"type":"array","minItems":0,"maxItems":100,"uniqueItems":true,"description":"Set of pickups related to this Transport Request.\n","items":{"$ref":"#/components/schemas/PickupInTransportRequest"}},"pickup_and_deliveries":{"type":"array","minItems":0,"maxItems":100,"uniqueItems":true,"description":"Set of pickupAndDelivery pairs related to this Transport Request.\n","items":{"$ref":"#/components/schemas/PickupDeliveryInTransportRequest"}}}}},"components/schemas/OrderStopTime":{"id":"components/schemas/OrderStopTime","kind":"json-schema","title":"OrderStopTime","data":{"type":"object","description":"The time that needs to be taken into account for stopping at the Order's location.\n","properties":{"value":{"$ref":"#/components/schemas/IsoDuration"},"combination_strategy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"combination_strategy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" determines how the application will resolve "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" information during the consolidation of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HIGHEST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(default)"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pick the highest of the available stop times from the Order, Location and/or Conditional(s)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUMULATIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add all available stop times from the Order, Location and/or Conditional(s)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OVERRIDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the stop time defined on the order. Ignore stop times from the Location and/or Conditional(s)."},"children":[]}]}]}]}],"enum":["HIGHEST","CUMULATIVE","OVERRIDE"],"default":"HIGHEST"}},"required":["value"]}},"components/schemas/Paging":{"id":"components/schemas/Paging","kind":"json-schema","title":"Paging","data":{"properties":{"total_items":{"type":"integer","format":"int32","example":100},"total_pages":{"type":"integer","format":"int32","example":10},"page_size":{"type":"integer","format":"int32","example":10},"current_page":{"type":"integer","format":"int32","example":1}}}},"components/schemas/PickupInTransportRequest":{"id":"components/schemas/PickupInTransportRequest","kind":"json-schema","title":"Pickup","data":{"title":"Pickup","description":"A single pickup order.\n","type":"object","properties":{"order":{"$ref":"#/components/schemas/OrderInformationInTransportRequest"},"pickup":{"$ref":"#/components/schemas/TransportInformation"}},"required":["order","pickup"]}},"components/schemas/PickupDeliveryInTransportRequest":{"id":"components/schemas/PickupDeliveryInTransportRequest","kind":"json-schema","title":"PickupDelivery","data":{"title":"PickupDelivery","description":"A single pickup-delivery pair.\n","type":"object","properties":{"order":{"$ref":"#/components/schemas/OrderInformationInTransportRequest"},"delivery":{"$ref":"#/components/schemas/TransportInformation"},"pickup":{"$ref":"#/components/schemas/TransportInformation"}},"required":["order","delivery","pickup"]}},"components/schemas/Pickup":{"id":"components/schemas/Pickup","kind":"json-schema","title":"Pickup","data":{"title":"Pickup","description":"Pickup entity","type":"object","properties":{"order":{"$ref":"#/components/schemas/OrderInformation"},"pickup":{"$ref":"#/components/schemas/TransportInformation"}},"required":["order","pickup"]}},"components/schemas/PickupDelivery":{"id":"components/schemas/PickupDelivery","kind":"json-schema","title":"PickupDelivery","data":{"title":"PickupDelivery","description":"Pickup and delivery entity","type":"object","properties":{"order":{"$ref":"#/components/schemas/OrderInformation"},"delivery":{"$ref":"#/components/schemas/TransportInformation"},"pickup":{"$ref":"#/components/schemas/TransportInformation"}},"required":["order","delivery","pickup"]}},"components/schemas/Problem":{"id":"components/schemas/Problem","kind":"json-schema","title":"Problem","data":{"type":"object","properties":{"type":{"type":"string","format":"uri","description":"An absolute URI that identifies the problem type.  When dereferenced,\nit SHOULD provide human-readable documentation for the problem type\n(e.g., using HTML).\n","example":"https://api.conundra.eu/problem/constraint-violation"},"title":{"type":"string","example":"Invalid ...","description":"A short, summary of the problem type. Written in english and readable\nfor engineers (usually not suited for non technical stakeholders and\nnot localized); example: Service Unavailable\n"},"status":{"type":"integer","format":"int32","description":"The HTTP status code generated by the origin server for this occurrence\nof the problem.\n","minimum":100,"exclusiveMaximum":600,"example":400},"detail":{"type":"string","description":"A human readable explanation specific to this occurrence of the\nproblem.\n","example":"string"},"instance":{"type":"string","format":"uri","example":"https://api.conundra.eu/orderbook/v1/orders/deliveries/chilled","description":"An absolute URI that identifies the specific occurrence of the problem.\nIt may or may not yield further information if dereferenced.\n"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}}}}},"components/schemas/ResolvedAddress":{"id":"components/schemas/ResolvedAddress","kind":"json-schema","title":"ResolvedAddress","data":{"title":"ResolvedAddress","type":"object","description":"The resolved address is geocoded based on the given address, with the quality of the resolving being specified by the field score.\n\nAddresses are only resolved when no geo point is provided on the provided address.\n","readOnly":true,"properties":{"geo_point":{"$ref":"#/components/schemas/GeoPoint"},"address_line":{"type":"string","example":"Voordries 41"},"city":{"type":"string","example":"Oosterzele"},"zip_code":{"type":"string","example":"9860"},"country_code":{"$ref":"#/components/schemas/CountryCode"},"score":{"type":"integer","format":"int32","example":9,"description":"This score ranges from 0 to 9, with 0 being the worst and 9 a perfectly geocoded address."}}}},"components/schemas/Requirements":{"id":"components/schemas/Requirements","kind":"json-schema","title":"Requirements","data":{"description":"Requirements that have to be fulfilled by the executor of an order at this location.\n","type":"object","properties":{"tags":{"description":"Properties that MUST be present on the executor.","type":"array","default":[],"uniqueItems":true,"items":{"type":"string","example":"tagX"}},"forbidden_tags":{"description":"Properties that MUST NOT be present on the executor.","type":"array","default":[],"uniqueItems":true,"items":{"type":"string","example":"tagY"}}}}},"components/schemas/SingleTransportRequestLookupResponse":{"id":"components/schemas/SingleTransportRequestLookupResponse","kind":"json-schema","title":"SingleTransportRequestLookupResponse","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TransportRequest"}}}},"components/schemas/SingleLocationLookupResponse":{"id":"components/schemas/SingleLocationLookupResponse","kind":"json-schema","title":"SingleLocationLookupResponse","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Location"}}}},"components/schemas/Time":{"id":"components/schemas/Time","kind":"json-schema","title":"Time","data":{"description":"Time supports 00:00-23:59h\n","type":"string","pattern":"^([0-1][0-9]|[2][0-3]):([0-5][0-9])$","example":"14:45"}},"components/schemas/TimeFrame":{"id":"components/schemas/TimeFrame","kind":"json-schema","title":"TimeFrame","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports two ways to specify when an order can be delivered:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"windowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" intervals are used in conjunction with a (site) Location's (planning) time windows or Conditionals. The windowed intervals will be limited to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the smallest common intersection between all applicable time windows from these."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"absolute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" intervals are absolute date times that will be used to plan the order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"windowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"absolute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" intervals in conjunction can solve many complicated cases, especially when taking the flexibility of Conditionals into"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one timerange is required, either absolute or windowed."},"children":[]}]}]}]}],"type":"object","properties":{"absolute":{"description":"A set of date-time intervals within which this activity of the Order can be executed. \n\nAbsolute timeframes will always be retained on the Order after consolidation.\n","type":"array","items":{"$ref":"#/components/schemas/AbsoluteTimeFrame"}},"windowed":{"description":"A set of date-time intervals within which this activity of the Order can be executed. These intervals will be intersected with the (planning) opening \nhours of a linked (site) location and/or timewindows defined on applicable Conditionals.\n","type":"array","items":{"$ref":"#/components/schemas/WindowedTimeFrame"}},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resulting time window after the order has been consolidated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When omitted, defaults to SERVICE_ARRIVAL."},"children":[]}]}]}],"type":"string","enum":["SERVICE_ARRIVAL","ARRIVAL_DEPARTURE","SERVICE_START","LOCATION_ARRIVAL"],"example":"SERVICE_ARRIVAL"}}}},"components/schemas/TimeWindow":{"id":"components/schemas/TimeWindow","kind":"json-schema","title":"TimeWindow","data":{"description":"One pair of open and corresponding closing moment.\n","type":"object","properties":{"open_time":{"$ref":"#/components/schemas/Time"},"open_day":{"$ref":"#/components/schemas/DayOfWeek"},"close_time":{"$ref":"#/components/schemas/Time"},"close_day":{"$ref":"#/components/schemas/DayOfWeek"},"cost":{"description":"The cost of a time window can be use to steer the optimization, where it wil prefer a lower cost. It's recommended to use integer values as decimal \nprecision is not guaranteed.\n","type":"number","format":"double","default":0}},"required":["open_time","open_day","close_time","close_day"]}},"components/schemas/TimeWindows":{"id":"components/schemas/TimeWindows","kind":"json-schema","title":"TimeWindows","data":{"description":"A collection of TimeWindows, defining when this location can be visited. This can be used to restrict an Order's windowed timeframes. If this property \nis not provided, we consider the location open 24/7.\n","type":"object","properties":{"description":{"description":"An optional description to accompany or clarify the opening hours.","type":"string","example":"a description"},"windows":{"type":"array","description":"An empty array is a valid option, as it indicates no specific opening hours and we consider it open 24/7.\n","minItems":0,"maxItems":100,"uniqueItems":true,"items":{"$ref":"#/components/schemas/TimeWindow"}}}}},"components/schemas/TransportInformation":{"id":"components/schemas/TransportInformation","kind":"json-schema","title":"TransportInformation","data":{"type":"object","description":"Properties specific to the activity that needs to be executed for fulfilling this order. In case of a PickupDelivery Order, these are two separate activities\nwith their own settings.\n","properties":{"site_location":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A known "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Order Book at which this activity occurs. This allows reusing the information present on the Location, such as opening hours, addresses"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requirements... Using a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"site_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also allows you to target sets of Orders based on a shared Location reference in a Conditional. Combining the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order properties with those of the linked Location can be fine-tuned using the combination strategies on relevant properties."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visit_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/LocationId"},"visit_location":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ad-hoc address at which this Order needs to be executed. When using a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visit_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" either address information should be present, or otherwise"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a geo point. When no geo_point is provided the address will be resolved by our geocoding service. The resolved information is read only (ie: only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available in a response)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"site_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/VisitLocation"},"stop_time":{"$ref":"#/components/schemas/OrderStopTime"},"service_time":{"$ref":"#/components/schemas/ServiceTime"},"sequence":{"type":"integer","format":"int32","description":"The sequence of this activity of the Order within a Route.\n\nNote: The sequence is applied to a route, not to trips within a route.\n","example":1},"time_frame":{"$ref":"#/components/schemas/TimeFrame"},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This property can be used to differentiate between orders visually. The orders within a planning will be shown in this color."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The color can be provided both as a CSS color name or using a hexadecimal color code (eg: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#123DEF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"red"},"labels":{"type":"array","maxItems":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Labels can be used for identifying sets of Orders. When starting an optimization, labels can be used for filtering the Order space and limiting the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optimization to specific subsets."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Labels can also be used as filters in select Order Book features or rules in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Plan profiles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a label contains a dash, it will be split into two upon exporting and re-importing the order set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"items":{"type":"string","minLength":1,"maxLength":200,"example":"labelA"}},"custom_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom data allows you te enrich an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with relevant information for the planner that is not part of the Order Book domain. Custom data properties"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defined on this activity of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be available in the planning context."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keys defined on this level will override any custom data that is defined on other entities or properties."},"children":[]}]}]}],"$ref":"#/components/schemas/CustomData"}},"required":["time_frame"]}},"components/schemas/TransportRequest":{"id":"components/schemas/TransportRequest","kind":"json-schema","title":"TransportRequest","data":{"type":"object","description":"transport request contains orders","properties":{"business_id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,512}$","example":"transportRequestA","description":"Unique reference ID"},"transport_category":{"type":"string","example":"transportCategoryA","description":"An optional category for the Transport Request, represented by its code. This category can be used for filtering in the user interface but is not exposed as a filter in the \nAPI's filter endpoints. There is no integration between Conditionals and Transport Request categories.\n"},"client":{"type":"string","example":"companyId","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional reference, by business_id, to a Company that is known in Order Book. Conditionals can target Orders contained within a TransportRequest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a certain Company as its client, thus providing the planner a way for applying business rules to all Orders for certain customers."},"children":[]}]}]}]},"earliest_start_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A calculated field that is the earliest start_at of all contained Orders."},"children":[]}]}]}],"type":"string","format":"date-time","example":"2021-01-01T10:15:30Z","readOnly":true},"description":{"type":"string","example":"a description","description":"A freeform text description of the Transport Request, providing additional details that might be of use for a planner.\n"},"orders":{"$ref":"#/components/schemas/Orders"},"custom_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom data allows you te enrich a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with relevant information for the planner that is not part of the Order Book domain. Custom data"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not propagate to its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/CustomData"},"etag":{"$ref":"#/components/schemas/Etag"},"version":{"type":"object","description":"The current version of the transport request. This is used for optimistic locking.\n","readOnly":true,"properties":{"value":{"type":"integer"}},"required":["value"]}},"required":["business_id"]}},"components/schemas/Violation":{"id":"components/schemas/Violation","kind":"json-schema","title":"Violation","data":{"type":"object","properties":{"field":{"type":"string","description":"A reference to the field in the request that triggered this violation.","example":"class.field"},"message":{"type":"string","description":"A message explaining the violation in the referenced field.","example":"a violation message"}}}},"components/schemas/VisitLocation":{"id":"components/schemas/VisitLocation","kind":"json-schema","title":"VisitLocation","data":{"type":"object","description":"Either address information should be present, or otherwise the geo point. The resolved information will be read-only and be filled out after resolving.","properties":{"name":{"description":"A name by which to identify this location","type":"string","example":"PTV Logistics"},"address_line":{"description":"The address line for this location's address.","type":"string","example":"Voordries 41"},"city":{"description":"The city of this location.\n\nRequired when no geo point is provided.\n","type":"string","example":"Oosterzele"},"zip_code":{"description":"The zip code of this location.\n\nRequired when no geo point is provided.\n","type":"string","example":"9860"},"country_code":{"description":"An ISO3166-1 alpha-2 two letter country code.\n\nRequired when no geo point is provided.\n","$ref":"#/components/schemas/CountryCode"},"geo_point":{"description":"The geo point identifying this location. If this is provided, all textual address information is optional.\n","$ref":"#/components/schemas/GeoPoint"},"resolved_address":{"$ref":"#/components/schemas/ResolvedAddress"},"labels":{"type":"array","description":"Labels associated with this visit location.\nNote: if a label contains a dash, it will be split into two upon exporting and re-importing the order set in PTV OptiFlow Route Optimization.\n","maxItems":100,"items":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,200}$","example":"warehouse"}}}}},"components/schemas/Delivery":{"id":"components/schemas/Delivery","kind":"json-schema","title":"Delivery","data":{"title":"Delivery","description":"Delivery entity","type":"object","properties":{"order":{"$ref":"#/components/schemas/OrderInformation"},"delivery":{"$ref":"#/components/schemas/TransportInformation"}},"required":["order","delivery"]}},"components/schemas/CursorPageOrders":{"id":"components/schemas/CursorPageOrders","kind":"json-schema","title":"CursorPageOrders","data":{"type":"object","properties":{"data":{"type":"array","description":"Subset of orders matching the provided query, limited to the size specified in the request.\n","items":{"$ref":"#/components/schemas/OrderSummary"}},"cursor":{"$ref":"#/components/schemas/Cursor"}},"required":["data","cursor"]}},"components/schemas/OrderSummary":{"id":"components/schemas/OrderSummary","kind":"json-schema","title":"OrderSummary","data":{"type":"object","description":"A summary representation of an order.","properties":{"business_id":{"type":"string","description":"The unique business identifier of the order.","example":"orderA"}},"required":["business_id"]}},"components/schemas/IsoDuration":{"id":"components/schemas/IsoDuration","kind":"json-schema","title":"IsoDuration","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ISO-formatted Duration, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601#Durations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wikipedia ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC-3339"},"children":[]}]}]}]}],"example":"PT5M"}},"components/schemas/MaxTimeInVehicle":{"id":"components/schemas/MaxTimeInVehicle","kind":"json-schema","title":"MaxTimeInVehicle","data":{"type":"object","description":"Constrains the maximum time this order's cargo may spend on a vehicle. If the constraint is violated, a penalty cost is incurred in the optimization.\n","properties":{"max_time":{"$ref":"#/components/schemas/IsoDuration","description":"The maximum duration the order's cargo is allowed to remain on a vehicle. Must be non-negative and at most 1 day (PT24H).\n"},"penalty":{"type":"number","format":"double","minimum":0,"maximum":10000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An indication for the penalty that is counted when exceeding the maximum time an order can be on a vehicle. The applied penalty is calculated as follows:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applied penalty = penalty * (amount_max_time_exceeded)² / (15_minutes)²"},"children":[]}]}]}],"example":1000}},"required":["max_time","penalty"]}},"components/schemas/ServiceTime":{"id":"components/schemas/ServiceTime","kind":"json-schema","title":"ServiceTime","data":{"type":"string","default":"PT0S","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The non-negative duration required for executing this activity in the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Needs to be an ISO-formatted Duration, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601#Durations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wikipedia ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC-3339"},"children":[]}]}]}]}],"example":"PT5M"}},"components/schemas/CursorPagePreplannedPartialRoutes":{"id":"components/schemas/CursorPagePreplannedPartialRoutes","kind":"json-schema","title":"CursorPagePreplannedPartialRoutes","data":{"type":"object","properties":{"data":{"type":"array","description":"Subset of preplanned partial routes matching the provided query, limited to the size specified in the request.\n","items":{"$ref":"#/components/schemas/PreplannedPartialRouteSummary"}},"cursor":{"$ref":"#/components/schemas/Cursor"}},"required":["data","cursor"]}},"components/schemas/PreplannedPartialRouteSummary":{"id":"components/schemas/PreplannedPartialRouteSummary","kind":"json-schema","title":"PreplannedPartialRouteSummary","data":{"type":"object","description":"A summary representation of a preplanned partial route.","properties":{"business_id":{"type":"string","description":"The unique business identifier of the preplanned partial route."},"etag":{"$ref":"#/components/schemas/Etag"}},"required":["business_id","etag"]}},"components/schemas/PartialRoute":{"id":"components/schemas/PartialRoute","kind":"json-schema","title":"PartialRoute","data":{"type":"object","properties":{"business_id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,512}$","readOnly":true,"example":"PPT-1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"plan_group":{"type":"string","example":"a plan group","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The (optional) plan group this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belong to. Plan Groups can be used for filtering the data included in a logistical optimization."},"children":[]}]}]}]},"same_route_group":{"type":"string","example":"route-group-01","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The (optional) route group this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to. All "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoutes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"same_route_group"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must share the same executor, ie: they will belong to the same route."},"children":[]}]}]}]},"requirements":{"$ref":"#/components/schemas/Requirements","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requirements that need to be fulfilled for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be considered feasible for an executor in a logistical optimization."},"children":[]}]}]}]},"labels":{"type":"array","default":[],"uniqueItems":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Labels can be used for identifying sets of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoutes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoutes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","example":"labelA"}},"stops":{"type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/components/schemas/Stop"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has a specific location where one or more pickups or deliveries need to be made, taking into account the timings for a stop."},"children":[]}]}]}]},"breaks":{"type":"array","default":[],"items":{"$ref":"#/components/schemas/Break"}}},"required":["business_id","stops"]}},"components/schemas/Stop":{"id":"components/schemas/Stop","kind":"json-schema","title":"Stop","data":{"type":"object","properties":{"visit_location":{"$ref":"#/components/schemas/VisitLocation"},"pickups":{"type":"array","items":{"$ref":"#/components/schemas/PickupActivity"}},"deliveries":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryActivity"}},"timings":{"type":"object","properties":{"arrival_at":{"type":"string","format":"date-time","example":"2021-01-01T10:15:30Z","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The planned time of arrival at the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stop"},"children":[]}]}]}]},"location_stop_time":{"type":"string","example":"PT45M","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The stop time for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be specified as a valid ISO Duration (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601#Durations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wikipedia ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC-3339"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Must be non negative."},"children":[]}]}]}]}},"required":["arrival_at"]}},"required":["visit_location","timings"]}},"components/schemas/PickupActivity":{"id":"components/schemas/PickupActivity","kind":"json-schema","title":"PickupActivity","data":{"type":"object","properties":{"order":{"type":"object","properties":{"business_id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,512}$","example":"Order-1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pickup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This must match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"capacities":{"type":"array","maxItems":8,"default":[],"uniqueItems":true,"items":{"$ref":"#/components/schemas/Capacity"}},"requirements":{"$ref":"#/components/schemas/Requirements"},"labels":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Labels can be used for identifying sets of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within a logistical optimization."},"children":[]}]}]}],"uniqueItems":true,"default":[],"items":{"type":"string","example":"labelA"}},"description":{"type":"string"},"custom_data":{"$ref":"#/components/schemas/CustomData"}},"required":["business_id"]},"timings":{"$ref":"#/components/schemas/OrderTimings"}},"required":["order","timings"]}},"components/schemas/DeliveryActivity":{"id":"components/schemas/DeliveryActivity","kind":"json-schema","title":"DeliveryActivity","data":{"type":"object","properties":{"order":{"type":"object","properties":{"business_id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,512}$","example":"Order-1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This must match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pickup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"requirements":{"$ref":"#/components/schemas/Requirements"},"labels":{"type":"array","default":[],"uniqueItems":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Labels can be used for identifying sets of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Orders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","example":"labelA"}},"custom_data":{"$ref":"#/components/schemas/CustomData"}},"required":["business_id"]},"timings":{"$ref":"#/components/schemas/OrderTimings"}},"required":["order","timings"]}},"components/schemas/Break":{"id":"components/schemas/Break","kind":"json-schema","title":"Break","data":{"type":"object","properties":{"at":{"type":"string","format":"date-time","example":"2021-01-01T10:15:30Z","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The planned start time of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Break"},"children":[]}]}]}]},"duration":{"type":"string","example":"PT8H","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The duration of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Break"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be an ISO-formatted Duration, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601#Durations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wikipedia ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC-3339"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be non negative."},"children":[]}]}]}]}},"required":["at","duration"]}},"components/schemas/OrderTimings":{"id":"components/schemas/OrderTimings","kind":"json-schema","title":"OrderTimings","data":{"type":"object","properties":{"start_at":{"type":"string","format":"date-time","example":"2021-01-01T10:15:30Z","description":"The planned time of start for this activity. \n\nMust be provided as an ISO-8601 formatted datetime.\n"},"service_time":{"type":"string","example":"PT5M","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The duration required for executing this activity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be an ISO-formatted Duration, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601#Durations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wikipedia ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc3339"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC-3339"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be non negative."},"children":[]}]}]}]}},"required":["start_at","service_time"]}},"schema_47":{"kind":"json-schema","data":{"type":"string"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"maximum":1000,"default":100},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,512}$"},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"object","properties":{"ETag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weak Etag (ex W/<etag_value>) which contains the (updated) version of the entity"},"children":[]}]}]}]}}},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"object","properties":{"ETag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weak Etag (ex W/<etag_value>) which contains the (updated) version of the entity"},"children":[]}]}]}]},"Preference-Applied":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to indicate whether a preference has been applied. (ex Preference-Applied: return=representation)"},"children":[]}]}]}]}}},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"object","properties":{"Preference-Applied":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to indicate whether a preference has been applied. (ex Preference-Applied: return=representation)"},"children":[]}]}]}]},"Location":{"type":"string","description":"contains the URI to the entity"}}},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"string","enum":["UNPLANNABLE"]},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"string","enum":["order","location","transport-request"]},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"default":1},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":10},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":100},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"contains the URI, with the ID of the created Transport Request ex /transport-requests"},"ETag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weak Etag (ex W/<etag_value>) which contains the (updated) version of the entity"},"children":[]}]}]}]},"Preference-Applied":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to indicate whether a preference has been applied. (ex Preference-Applied: return=representation)"},"children":[]}]}]}]}}},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"contains the URI, with the business ID of the created company"},"ETag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weak Etag (ex W/<etag_value>) which contains the (updated) version of the entity"},"children":[]}]}]}]},"Preference-Applied":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to indicate whether a preference has been applied. (ex Preference-Applied: return=representation)"},"children":[]}]}]}]}}},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CountryCode"},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contains the URI, including the ID of the created conditional ex /conditional/{id}"},"children":[]}]}]}]},"ETag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weak Etag (ex W/<etag_value>) which contains the (updated) version of the entity"},"children":[]}]}]}]},"Preference-Applied":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to indicate whether a preference has been applied. (ex Preference-Applied: return=representation)"},"children":[]}]}]}]}}},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"object","properties":{"ETag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weak Etag (ex W/<etag_value>) which contains the (updated) version of the entity"},"children":[]}]}]}]},"Preference-Applied":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to indicate whether a preference has been applied. (ex Preference-Applied: return=representation)"},"children":[]}]}]}]},"Location":{"type":"string","description":"contains the URI to the entity"}}},"id":"schema_64"}},"exampleStore":{"components/examples/pickup_example":{"id":"components/examples/pickup_example","value":{"order":{"order_category":"orderCategoryA","description":"a description","capacities":[{"type":"volume","value":20}],"mandatory":true,"requirements":{"tags":["tagX"],"forbidden_tags":["tagY"],"combination_strategy":"COMBINE"},"lifo_groups":["lifo_group"],"outsourcing_cost":0,"custom_data":{"shop_manager":"John Smith"},"plan_group":"a plan group","client":"companyId","max_time_in_vehicle":{"max_time":"PT8H","penalty":1000}},"pickup":{"site_location":{"location_id":"locationA"},"stop_time":{"value":"PT5M","combination_strategy":"HIGHEST"},"service_time":"PT5M","sequence":1,"time_frame":{"absolute":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z","cost":42}],"windowed":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z"}]},"color":"red","labels":["labelA"],"custom_data":{"shop_manager":"John Smith"}}},"summary":"Complete pickup order example","description":"Comprehensive example of a pickup order using site location"},"components/examples/delivery_example":{"id":"components/examples/delivery_example","value":{"order":{"order_category":"orderCategoryA","description":"a description","capacities":[{"type":"volume","value":20}],"mandatory":true,"requirements":{"tags":["tagX"],"forbidden_tags":["tagY"],"combination_strategy":"COMBINE"},"lifo_groups":["lifo_group"],"outsourcing_cost":0,"custom_data":{"shop_manager":"John Smith"},"plan_group":"a plan group","client":"companyId","max_time_in_vehicle":{"max_time":"PT8H","penalty":1000}},"delivery":{"site_location":{"location_id":"locationA"},"stop_time":{"value":"PT5M","combination_strategy":"HIGHEST"},"service_time":"PT5M","sequence":1,"time_frame":{"absolute":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z","cost":42}],"windowed":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z"}]},"color":"red","labels":["labelA"],"custom_data":{"shop_manager":"John Smith"}}},"summary":"Complete delivery order example","description":"Comprehensive example of a delivery order using site location"},"components/examples/pickup_delivery_example":{"id":"components/examples/pickup_delivery_example","value":{"order":{"order_category":"orderCategoryA","description":"a description","capacities":[{"type":"volume","value":20}],"mandatory":true,"requirements":{"tags":["tagX"],"forbidden_tags":["tagY"],"combination_strategy":"COMBINE"},"lifo_groups":["lifo_group"],"outsourcing_cost":0,"custom_data":{"shop_manager":"John Smith"},"plan_group":"a plan group","client":"companyId","max_time_in_vehicle":{"max_time":"PT8H","penalty":1000}},"pickup":{"site_location":{"location_id":"locationA"},"stop_time":{"value":"PT5M","combination_strategy":"HIGHEST"},"service_time":"PT5M","sequence":1,"time_frame":{"absolute":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z","cost":42}],"windowed":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z"}]},"color":"red","labels":["labelA"],"custom_data":{"shop_manager":"John Smith"}},"delivery":{"site_location":{"location_id":"locationB"},"stop_time":{"value":"PT10M","combination_strategy":"HIGHEST"},"service_time":"PT10M","sequence":2,"time_frame":{"absolute":[{"start_at":"2021-01-01T14:15:30Z","end_at":"2021-01-01T15:15:30Z","cost":42}],"windowed":[{"start_at":"2021-01-01T14:15:30Z","end_at":"2021-01-01T15:15:30Z"}]},"color":"blue","labels":["labelB"],"custom_data":{"delivery_notes":"Handle with care"}}},"summary":"Complete pickup-delivery order example","description":"Comprehensive example of a pickup-delivery order using site locations"},"paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/put/requestBody/content/application~1json/examples/pickup_example":{"value":{"order":{"order_category":"orderCategoryA","description":"a description","capacities":[{"type":"volume","value":20}],"mandatory":true,"requirements":{"tags":["tagX"],"forbidden_tags":["tagY"],"combination_strategy":"COMBINE"},"lifo_groups":["lifo_group"],"outsourcing_cost":0,"custom_data":{"shop_manager":"John Smith"},"plan_group":"a plan group","client":"companyId","max_time_in_vehicle":{"max_time":"PT8H","penalty":1000}},"pickup":{"site_location":{"location_id":"locationA"},"stop_time":{"value":"PT5M","combination_strategy":"HIGHEST"},"service_time":"PT5M","sequence":1,"time_frame":{"absolute":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z","cost":42}],"windowed":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z"}]},"color":"red","labels":["labelA"],"custom_data":{"shop_manager":"John Smith"}}},"key":"pickup_example","summary":"Complete pickup order example","description":"Comprehensive example of a pickup order using site location","id":"paths/~1transport-requests~1{business_id}~1orders~1pickups~1{order_id}/put/requestBody/content/application~1json/examples/pickup_example"},"paths/~1orders~1pickups~1{business_id}/put/requestBody/content/application~1json/examples/pickup_example":{"value":{"order":{"order_category":"orderCategoryA","description":"a description","capacities":[{"type":"volume","value":20}],"mandatory":true,"requirements":{"tags":["tagX"],"forbidden_tags":["tagY"],"combination_strategy":"COMBINE"},"lifo_groups":["lifo_group"],"outsourcing_cost":0,"custom_data":{"shop_manager":"John Smith"},"plan_group":"a plan group","client":"companyId","max_time_in_vehicle":{"max_time":"PT8H","penalty":1000}},"pickup":{"site_location":{"location_id":"locationA"},"stop_time":{"value":"PT5M","combination_strategy":"HIGHEST"},"service_time":"PT5M","sequence":1,"time_frame":{"absolute":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z","cost":42}],"windowed":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z"}]},"color":"red","labels":["labelA"],"custom_data":{"shop_manager":"John Smith"}}},"key":"pickup_example","summary":"Complete pickup order example","description":"Comprehensive example of a pickup order using site location","id":"paths/~1orders~1pickups~1{business_id}/put/requestBody/content/application~1json/examples/pickup_example"},"paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/put/requestBody/content/application~1json/examples/delivery_example":{"value":{"order":{"order_category":"orderCategoryA","description":"a description","capacities":[{"type":"volume","value":20}],"mandatory":true,"requirements":{"tags":["tagX"],"forbidden_tags":["tagY"],"combination_strategy":"COMBINE"},"lifo_groups":["lifo_group"],"outsourcing_cost":0,"custom_data":{"shop_manager":"John Smith"},"plan_group":"a plan group","client":"companyId","max_time_in_vehicle":{"max_time":"PT8H","penalty":1000}},"delivery":{"site_location":{"location_id":"locationA"},"stop_time":{"value":"PT5M","combination_strategy":"HIGHEST"},"service_time":"PT5M","sequence":1,"time_frame":{"absolute":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z","cost":42}],"windowed":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z"}]},"color":"red","labels":["labelA"],"custom_data":{"shop_manager":"John Smith"}}},"key":"delivery_example","summary":"Complete delivery order example","description":"Comprehensive example of a delivery order using site location","id":"paths/~1transport-requests~1{business_id}~1orders~1deliveries~1{order_id}/put/requestBody/content/application~1json/examples/delivery_example"},"paths/~1orders~1deliveries~1{business_id}/put/requestBody/content/application~1json/examples/delivery_example":{"value":{"order":{"order_category":"orderCategoryA","description":"a description","capacities":[{"type":"volume","value":20}],"mandatory":true,"requirements":{"tags":["tagX"],"forbidden_tags":["tagY"],"combination_strategy":"COMBINE"},"lifo_groups":["lifo_group"],"outsourcing_cost":0,"custom_data":{"shop_manager":"John Smith"},"plan_group":"a plan group","client":"companyId","max_time_in_vehicle":{"max_time":"PT8H","penalty":1000}},"delivery":{"site_location":{"location_id":"locationA"},"stop_time":{"value":"PT5M","combination_strategy":"HIGHEST"},"service_time":"PT5M","sequence":1,"time_frame":{"absolute":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z","cost":42}],"windowed":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z"}]},"color":"red","labels":["labelA"],"custom_data":{"shop_manager":"John Smith"}}},"key":"delivery_example","summary":"Complete delivery order example","description":"Comprehensive example of a delivery order using site location","id":"paths/~1orders~1deliveries~1{business_id}/put/requestBody/content/application~1json/examples/delivery_example"},"paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example":{"value":{"order":{"order_category":"orderCategoryA","description":"a description","capacities":[{"type":"volume","value":20}],"mandatory":true,"requirements":{"tags":["tagX"],"forbidden_tags":["tagY"],"combination_strategy":"COMBINE"},"lifo_groups":["lifo_group"],"outsourcing_cost":0,"custom_data":{"shop_manager":"John Smith"},"plan_group":"a plan group","client":"companyId","max_time_in_vehicle":{"max_time":"PT8H","penalty":1000}},"pickup":{"site_location":{"location_id":"locationA"},"stop_time":{"value":"PT5M","combination_strategy":"HIGHEST"},"service_time":"PT5M","sequence":1,"time_frame":{"absolute":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z","cost":42}],"windowed":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z"}]},"color":"red","labels":["labelA"],"custom_data":{"shop_manager":"John Smith"}},"delivery":{"site_location":{"location_id":"locationB"},"stop_time":{"value":"PT10M","combination_strategy":"HIGHEST"},"service_time":"PT10M","sequence":2,"time_frame":{"absolute":[{"start_at":"2021-01-01T14:15:30Z","end_at":"2021-01-01T15:15:30Z","cost":42}],"windowed":[{"start_at":"2021-01-01T14:15:30Z","end_at":"2021-01-01T15:15:30Z"}]},"color":"blue","labels":["labelB"],"custom_data":{"delivery_notes":"Handle with care"}}},"key":"pickup_delivery_example","summary":"Complete pickup-delivery order example","description":"Comprehensive example of a pickup-delivery order using site locations","id":"paths/~1transport-requests~1{business_id}~1orders~1pickup-deliveries~1{order_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example"},"paths/~1orders~1pickup-deliveries~1{business_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example":{"value":{"order":{"order_category":"orderCategoryA","description":"a description","capacities":[{"type":"volume","value":20}],"mandatory":true,"requirements":{"tags":["tagX"],"forbidden_tags":["tagY"],"combination_strategy":"COMBINE"},"lifo_groups":["lifo_group"],"outsourcing_cost":0,"custom_data":{"shop_manager":"John Smith"},"plan_group":"a plan group","client":"companyId","max_time_in_vehicle":{"max_time":"PT8H","penalty":1000}},"pickup":{"site_location":{"location_id":"locationA"},"stop_time":{"value":"PT5M","combination_strategy":"HIGHEST"},"service_time":"PT5M","sequence":1,"time_frame":{"absolute":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z","cost":42}],"windowed":[{"start_at":"2021-01-01T10:15:30Z","end_at":"2021-01-01T11:15:30Z"}]},"color":"red","labels":["labelA"],"custom_data":{"shop_manager":"John Smith"}},"delivery":{"site_location":{"location_id":"locationB"},"stop_time":{"value":"PT10M","combination_strategy":"HIGHEST"},"service_time":"PT10M","sequence":2,"time_frame":{"absolute":[{"start_at":"2021-01-01T14:15:30Z","end_at":"2021-01-01T15:15:30Z","cost":42}],"windowed":[{"start_at":"2021-01-01T14:15:30Z","end_at":"2021-01-01T15:15:30Z"}]},"color":"blue","labels":["labelB"],"custom_data":{"delivery_notes":"Handle with care"}}},"key":"pickup_delivery_example","summary":"Complete pickup-delivery order example","description":"Comprehensive example of a pickup-delivery order using site locations","id":"paths/~1orders~1pickup-deliveries~1{business_id}/put/requestBody/content/application~1json/examples/pickup_delivery_example"}},"securitySchemeStore":{"clientCredentials":{"id":"clientCredentials","type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID and secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}},"servers":[{"url":"/_mock/apis/order-book/order-book-api","isMockServer":true,"description":"Mock server"},{"url":"https://api.conundra.eu/orderbook/v1","description":"Order Book API Production"}]},"options":{"codeSamples":{"languages":[]},"hidePropertiesPrefix":true,"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"url":"/_mock/apis/order-book/order-book-api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/order-book/order-book-api.json?download"},{"url":"/_bundle/apis/order-book/order-book-api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"PTV OptiFlow Order Book API","description":"Order Book provides ready-to-run domain-specific logistic data governance for your route optimization.\n"}},"baseSlug":"/apis/order-book/order-book-api","routesMapping":{}}