{"items":[{"type":"link","label":"zipmend API","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"zipmend API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://docs.zipmend.com","url":"https://docs.zipmend.com"},{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"api@zipmend.com","label":"api@zipmend.com","withCopyButton":true,"copyContent":"api@zipmend.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"MIT","url":"https://opensource.org/license/mit/"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://zipmend.com/agb/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"zipmend API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Documentation for the zipmend API"}],"sectionId":"/openapi"}],"sectionId":"/openapi"}]}]}},{"type":"group","label":"Cities","link":"/openapi/cities","routeSlug":"/openapi/cities","items":[{"label":"Get cities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/cities/getcities","routeSlug":"/openapi/cities/getcities","metadata":{"seo":{"title":"Get cities","description":"Get cities by country code and search term"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCities","name":"Get cities","isWebhook":false,"pointer":"/paths/~1cities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get cities by country code and search term"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"country","in":"query","schemaId":"components/schemas/Country","required":true},{"name":"query","in":"query","schemaId":"schema_0"}],"pointer":"/paths/~1cities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cities","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"parameters":{"path":[],"query":[{"name":"country","in":"query","required":true,"example":"NL","schemaId":"components/schemas/Country"},{"name":"query","in":"query","example":"8051 CP Hattem","schemaId":"schema_0"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/cities","href":"cities/getcities","openApiOperationId":"getCities","summary":"Get cities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success!","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCitiesResponse","exampleIds":["paths/~1cities/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/GetCitiesResponse","exampleIds":["paths/~1cities/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cities/get/responses/401/content/application~1json/examples/unauthorized_example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1cities/get/responses/401/content/application~1json/examples/unauthorized_example"]}],"pointer":"/paths/~1cities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCitiesResponse","exampleIds":["paths/~1cities/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCitiesResponse","exampleIds":["paths/~1cities/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1cities/get/responses/401/content/application~1json/examples/unauthorized_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1cities/get/responses/401/content/application~1json/examples/unauthorized_example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cities/getcities"}],"panels":[]}]},"httpPath":"/cities"}],"content":{"contentType":"group","meta":{"name":"Cities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cities","showPageActions":true},{"nodeType":"markdoc","content":"Find location based on city and zipcode"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cities","summary":"Get cities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cities/getcities","deprecated":false}]}]}]}]}},{"type":"group","label":"Price","link":"/openapi/price","routeSlug":"/openapi/price","items":[{"label":"Calculate price","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/price/calculateprice","routeSlug":"/openapi/price/calculateprice","metadata":{"seo":{"title":"Calculate price","description":"Calculate a transport price, based on loadings, unloadings and items"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"calculatePrice","name":"Calculate price","isWebhook":false,"pointer":"/paths/~1price/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calculate price","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Calculate a transport price, based on loadings, unloadings and items"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePriceRequest","exampleIds":["paths/~1price/post/requestBody/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/CreatePriceRequest","exampleIds":["paths/~1price/post/requestBody/content/application~1json/examples/default_example"],"pointer":"/paths/~1price/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/price","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePriceRequest","exampleIds":["paths/~1price/post/requestBody/content/application~1json/examples/default_example"]}},"responseCodes":["200","401","422"],"pointer":"/price","href":"price/calculateprice","openApiOperationId":"calculatePrice","summary":"Calculate price"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"schemaId":"components/schemas/CreatePriceRequest","exampleIds":["paths/~1price/post/requestBody/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePriceRequest","exampleIds":["paths/~1price/post/requestBody/content/application~1json/examples/default_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePriceResponse","exampleIds":["paths/~1price/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/CreatePriceResponse","exampleIds":["paths/~1price/post/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1price/post/responses/401/content/application~1json/examples/unauthorized_example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1price/post/responses/401/content/application~1json/examples/unauthorized_example"]},{"code":"422","description":"Unprocessable Entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1price/post/responses/422/content/application~1json/examples/price_error_example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1price/post/responses/422/content/application~1json/examples/price_error_example"]}],"pointer":"/paths/~1price/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatePriceResponse","exampleIds":["paths/~1price/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePriceResponse","exampleIds":["paths/~1price/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1price/post/responses/401/content/application~1json/examples/unauthorized_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1price/post/responses/401/content/application~1json/examples/unauthorized_example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1price/post/responses/422/content/application~1json/examples/price_error_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1price/post/responses/422/content/application~1json/examples/price_error_example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/price/calculateprice"}],"panels":[]}]},"httpPath":"/price"}],"content":{"contentType":"group","meta":{"name":"Price"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Price","showPageActions":true},{"nodeType":"markdoc","content":"Get price"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/price","summary":"Calculate price","prefix":{"name":"post","color":"post"},"badges":[],"link":"/price/calculateprice","deprecated":false}]}]}]}]}},{"type":"group","label":"Booking","link":"/openapi/booking","routeSlug":"/openapi/booking","items":[{"label":"Book a transport","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/booking/booktransport","routeSlug":"/openapi/booking/booktransport","metadata":{"seo":{"title":"Book a transport","description":"Endpoint to book a transport"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bookTransport","name":"Book a transport","isWebhook":false,"pointer":"/paths/~1booking~1publish/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Book a transport","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to book a transport"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublishBookingRequest","exampleIds":["paths/~1booking~1publish/post/requestBody/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/PublishBookingRequest","exampleIds":["paths/~1booking~1publish/post/requestBody/content/application~1json/examples/default_example"],"pointer":"/paths/~1booking~1publish/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/booking/publish","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PublishBookingRequest","exampleIds":["paths/~1booking~1publish/post/requestBody/content/application~1json/examples/default_example"]}},"responseCodes":["200","401","422"],"pointer":"/booking/publish","href":"booking/booktransport","openApiOperationId":"bookTransport","summary":"Book a transport"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"schemaId":"components/schemas/PublishBookingRequest","exampleIds":["paths/~1booking~1publish/post/requestBody/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublishBookingRequest","exampleIds":["paths/~1booking~1publish/post/requestBody/content/application~1json/examples/default_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpecialEventResponse","exampleIds":["paths/~1booking~1publish/post/responses/200/content/application~1json/examples/publish_success_example"]}},"schemaId":"components/schemas/SpecialEventResponse","exampleIds":["paths/~1booking~1publish/post/responses/200/content/application~1json/examples/publish_success_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1booking~1publish/post/responses/401/content/application~1json/examples/unauthorized_example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1booking~1publish/post/responses/401/content/application~1json/examples/unauthorized_example"]},{"code":"422","description":"Unprocessable Entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1booking~1publish/post/responses/422/content/application~1json/examples/publish_error_example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1booking~1publish/post/responses/422/content/application~1json/examples/publish_error_example"]}],"pointer":"/paths/~1booking~1publish/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SpecialEventResponse","exampleIds":["paths/~1booking~1publish/post/responses/200/content/application~1json/examples/publish_success_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpecialEventResponse","exampleIds":["paths/~1booking~1publish/post/responses/200/content/application~1json/examples/publish_success_example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1booking~1publish/post/responses/401/content/application~1json/examples/unauthorized_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1booking~1publish/post/responses/401/content/application~1json/examples/unauthorized_example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1booking~1publish/post/responses/422/content/application~1json/examples/publish_error_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1booking~1publish/post/responses/422/content/application~1json/examples/publish_error_example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/booking/booktransport"}],"panels":[]}]},"httpPath":"/booking/publish"}],"content":{"contentType":"group","meta":{"name":"Booking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Booking","showPageActions":true},{"nodeType":"markdoc","content":"Book a transport"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/booking/publish","summary":"Book a transport","prefix":{"name":"post","color":"post"},"badges":[],"link":"/booking/booktransport","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders","link":"/openapi/orders","routeSlug":"/openapi/orders","items":[{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/listorders","routeSlug":"/openapi/orders/listorders","metadata":{"seo":{"title":"List orders","description":"Retrieve orders with optional filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrders","name":"List orders","isWebhook":false,"pointer":"/paths/~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve orders with optional filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status[]","in":"query","schemaId":"schema_1","description":"Filter by order status. Repeat the parameter for multiple values.","example":["draft","placed"]},{"name":"order-number","in":"query","schemaId":"schema_2","description":"Filter by order number."}],"pointer":"/paths/~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"parameters":{"path":[],"query":[{"name":"status[]","in":"query","required":false,"example":["draft","placed"],"schemaId":"schema_1","style":"form","explode":true},{"name":"order-number","in":"query","required":false,"example":231231,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/orders","href":"orders/listorders","openApiOperationId":"listOrders","summary":"List orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success!","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1orders/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1orders/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/401/content/application~1json/examples/unauthorized_example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/401/content/application~1json/examples/unauthorized_example"]}],"pointer":"/paths/~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1orders/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrdersResponse","exampleIds":["paths/~1orders/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/401/content/application~1json/examples/unauthorized_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders/get/responses/401/content/application~1json/examples/unauthorized_example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listorders"}],"panels":[]}]},"httpPath":"/orders"},{"label":"Get order by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/getorderbyid","routeSlug":"/openapi/orders/getorderbyid","metadata":{"seo":{"title":"Get order by ID","description":"Retrieve a single order by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderById","name":"Get order by ID","isWebhook":false,"pointer":"/paths/~1orders~1{orderID}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get order by 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 order by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderID","in":"path","schemaId":"schema_3","description":"The ID of the order to retrieve","required":true}],"pointer":"/paths/~1orders~1{orderID}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{orderID}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"parameters":{"path":[{"name":"orderID","in":"path","required":true,"example":"68b9627a8fb3ff609808c842","schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/orders/{orderID}","href":"orders/getorderbyid","openApiOperationId":"getOrderById","summary":"Get order by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success!","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrderByIdResponse","exampleIds":["paths/~1orders~1{orderID}/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/GetOrderByIdResponse","exampleIds":["paths/~1orders~1{orderID}/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{orderID}/get/responses/401/content/application~1json/examples/unauthorized_example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{orderID}/get/responses/401/content/application~1json/examples/unauthorized_example"]},{"code":"404","description":"Order not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/get/responses/404/content/application~1json/examples/order_not_found_example"]}},"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/get/responses/404/content/application~1json/examples/order_not_found_example"]}],"pointer":"/paths/~1orders~1{orderID}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrderByIdResponse","exampleIds":["paths/~1orders~1{orderID}/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrderByIdResponse","exampleIds":["paths/~1orders~1{orderID}/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{orderID}/get/responses/401/content/application~1json/examples/unauthorized_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{orderID}/get/responses/401/content/application~1json/examples/unauthorized_example"]}}},{"code":"404","schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/get/responses/404/content/application~1json/examples/order_not_found_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/get/responses/404/content/application~1json/examples/order_not_found_example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getorderbyid"}],"panels":[]}]},"httpPath":"/orders/{orderID}"},{"label":"Update order status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/updateorderstatus","routeSlug":"/openapi/orders/updateorderstatus","metadata":{"seo":{"title":"Update order status","description":"Update the status of an order. Currently, it is only possible to use this endpoint to cancel a transport"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrderStatus","name":"Update order status","isWebhook":false,"pointer":"/paths/~1orders~1{orderID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update order status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the status of an order. Currently, it is only possible to use this endpoint to cancel a transport"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderID","in":"path","schemaId":"schema_4","description":"The ID of the order to update","required":true}],"pointer":"/paths/~1orders~1{orderID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateOrderRequest","exampleIds":["paths/~1orders~1{orderID}/put/requestBody/content/application~1json/examples/cancel_order_example"]}},"schemaId":"components/schemas/UpdateOrderRequest","exampleIds":["paths/~1orders~1{orderID}/put/requestBody/content/application~1json/examples/cancel_order_example"],"pointer":"/paths/~1orders~1{orderID}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/orders/{orderID}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"parameters":{"path":[{"name":"orderID","in":"path","required":true,"example":"68822b0ea09ba5655e0a2032","schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateOrderRequest","exampleIds":["paths/~1orders~1{orderID}/put/requestBody/content/application~1json/examples/cancel_order_example"]}},"responseCodes":["200","401","403","404","409","422"],"pointer":"/orders/{orderID}","href":"orders/updateorderstatus","openApiOperationId":"updateOrderStatus","summary":"Update order status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"schemaId":"components/schemas/UpdateOrderRequest","exampleIds":["paths/~1orders~1{orderID}/put/requestBody/content/application~1json/examples/cancel_order_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateOrderRequest","exampleIds":["paths/~1orders~1{orderID}/put/requestBody/content/application~1json/examples/cancel_order_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateOrderResponse","exampleIds":["paths/~1orders~1{orderID}/put/responses/200/content/application~1json/examples/update_success_example"]}},"schemaId":"components/schemas/UpdateOrderResponse","exampleIds":["paths/~1orders~1{orderID}/put/responses/200/content/application~1json/examples/update_success_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{orderID}/put/responses/401/content/application~1json/examples/unauthorized_example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{orderID}/put/responses/401/content/application~1json/examples/unauthorized_example"]},{"code":"403","description":"Forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/put/responses/403/content/application~1json/examples/ownership_error_example"]}},"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/put/responses/403/content/application~1json/examples/ownership_error_example"]},{"code":"404","description":"Order not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/put/responses/404/content/application~1json/examples/order_not_found_example"]}},"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/put/responses/404/content/application~1json/examples/order_not_found_example"]},{"code":"409","description":"Conflict - Order cannot be updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/put/responses/409/content/application~1json/examples/cancellation_window_expired_example","paths/~1orders~1{orderID}/put/responses/409/content/application~1json/examples/order_status_error_example"]}},"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/put/responses/409/content/application~1json/examples/cancellation_window_expired_example","paths/~1orders~1{orderID}/put/responses/409/content/application~1json/examples/order_status_error_example"]},{"code":"422","description":"Unprocessable Entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{orderID}/put/responses/422/content/application~1json/examples/update_error_example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{orderID}/put/responses/422/content/application~1json/examples/update_error_example"]}],"pointer":"/paths/~1orders~1{orderID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateOrderResponse","exampleIds":["paths/~1orders~1{orderID}/put/responses/200/content/application~1json/examples/update_success_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateOrderResponse","exampleIds":["paths/~1orders~1{orderID}/put/responses/200/content/application~1json/examples/update_success_example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{orderID}/put/responses/401/content/application~1json/examples/unauthorized_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{orderID}/put/responses/401/content/application~1json/examples/unauthorized_example"]}}},{"code":"403","schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/put/responses/403/content/application~1json/examples/ownership_error_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/put/responses/403/content/application~1json/examples/ownership_error_example"]}}},{"code":"404","schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/put/responses/404/content/application~1json/examples/order_not_found_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/put/responses/404/content/application~1json/examples/order_not_found_example"]}}},{"code":"409","schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/put/responses/409/content/application~1json/examples/cancellation_window_expired_example","paths/~1orders~1{orderID}/put/responses/409/content/application~1json/examples/order_status_error_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1orders~1{orderID}/put/responses/409/content/application~1json/examples/cancellation_window_expired_example","paths/~1orders~1{orderID}/put/responses/409/content/application~1json/examples/order_status_error_example"]}}},{"code":"422","schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{orderID}/put/responses/422/content/application~1json/examples/update_error_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1orders~1{orderID}/put/responses/422/content/application~1json/examples/update_error_example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/updateorderstatus"}],"panels":[]}]},"httpPath":"/orders/{orderID}"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"Manage transport orders"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orders","summary":"List orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listorders","deprecated":false},{"title":"/orders/{orderID}","summary":"Get order by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getorderbyid","deprecated":false},{"title":"/orders/{orderID}","summary":"Update order status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/updateorderstatus","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"message":{"type":"string","description":"A descriptive error message.","example":"Bad Request"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","example":"Das Feld loadings ist erforderlich."}}}},"required":["message","errors"]}},"components/schemas/SimpleError":{"id":"components/schemas/SimpleError","kind":"json-schema","title":"SimpleError","data":{"type":"object","properties":{"message":{"type":"string","description":"A descriptive error message.","example":"Not allowed"}},"required":["message"]}},"components/schemas/Name":{"id":"components/schemas/Name","kind":"json-schema","title":"Name","data":{"type":"string","example":"Hamburg"}},"components/schemas/ZipCode":{"id":"components/schemas/ZipCode","kind":"json-schema","title":"ZipCode","data":{"type":"string","example":"8051 CP"}},"components/schemas/Country":{"id":"components/schemas/Country","kind":"json-schema","title":"Country","data":{"type":"string","example":"NL"}},"components/schemas/Date":{"id":"components/schemas/Date","kind":"json-schema","title":"Date","data":{"type":"string","format":"date-time","example":"2024-07-19T08:00:00+01:00"}},"components/schemas/Phone":{"id":"components/schemas/Phone","kind":"json-schema","title":"Phone","data":{"description":"Phone number (optional).","type":"string","example":"+491234567890"}},"components/schemas/GetCitiesResponse":{"id":"components/schemas/GetCitiesResponse","kind":"json-schema","title":"GetCitiesResponse","data":{"description":"List of cities","type":"object","properties":{"message":{"type":"string","example":"Success!"},"data":{"type":"array","items":{"$ref":"#/components/schemas/City"}}},"required":["message","data"]}},"components/schemas/City":{"id":"components/schemas/City","kind":"json-schema","title":"City","data":{"description":"City details including name, zip code, and country.","type":"object","properties":{"name":{"$ref":"#/components/schemas/Name"},"zip_code":{"$ref":"#/components/schemas/ZipCode"},"country":{"$ref":"#/components/schemas/Country"}}}},"components/schemas/Item":{"id":"components/schemas/Item","kind":"json-schema","title":"Item","data":{"description":"Goods description","type":"object","properties":{"quantity":{"type":"integer","example":3},"length":{"type":"integer","example":120},"width":{"type":"integer","example":100},"height":{"type":"integer","example":80},"weight":{"type":"integer","example":320}}}},"components/schemas/FTL_Timeslot_Duration":{"id":"components/schemas/FTL_Timeslot_Duration","kind":"json-schema","title":"FTL_Timeslot_Duration","data":{"type":"integer","description":"The FTL timeslot duration must be either 6, 3, or 0.","enum":[6,3,0],"example":6}},"components/schemas/CreatePriceRequest":{"id":"components/schemas/CreatePriceRequest","kind":"json-schema","title":"CreatePriceRequest","data":{"description":"Values to calculate a price.","type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"loadings":{"type":"array","items":{"$ref":"#/components/schemas/City"}},"unloadings":{"type":"array","items":{"$ref":"#/components/schemas/City"}},"loading_date":{"type":"string","$ref":"#/components/schemas/Date"},"ftl_timeslot_duration":{"$ref":"#/components/schemas/FTL_Timeslot_Duration"}},"required":["loadings","unloadings","loading_date"]}},"components/schemas/CreatePriceResponse":{"id":"components/schemas/CreatePriceResponse","kind":"json-schema","title":"CreatePriceResponse","data":{"description":"Response object for a price calculation.","type":"object","properties":{"message":{"type":"string","example":"Success!"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PriceObject"}}},"required":["message","data"]}},"components/schemas/SpotTimes":{"id":"components/schemas/SpotTimes","kind":"json-schema","title":"SpotTimes","data":{"type":"object","properties":{"start":{"type":"string","$ref":"#/components/schemas/Date","example":"2024-09-19T09:00:00+02:00"},"end":{"type":"string","$ref":"#/components/schemas/Date","example":"2024-09-19T09:00:00+02:00"}}}},"components/schemas/ExtraService":{"id":"components/schemas/ExtraService","kind":"json-schema","title":"ExtraService","data":{"type":"object","properties":{"label":{"type":"string","example":"loadingThroughDriver"},"cost":{"type":"number","example":29.9}}}},"components/schemas/SpotAddresses":{"id":"components/schemas/SpotAddresses","kind":"json-schema","title":"SpotAddresses","data":{"type":"object","properties":{"company_name":{"type":"string","example":"zipmend GmbH"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"address_line_1":{"type":"string","example":"Große Reichenstraße 27"},"address_line_2":{"type":"string","example":"Floor 3"},"country":{"type":"string","example":"DE"},"zip":{"type":"string","example":"28779"},"city":{"type":"string","example":"Hamburg"},"phone":{"type":"string","$ref":"#/components/schemas/Phone","example":"+491234567890"},"reference_number":{"type":"string","example":"Ref12345"},"dates":{"type":"array","items":{"$ref":"#/components/schemas/SpotTimes"}}}}},"components/schemas/PriceObject":{"id":"components/schemas/PriceObject","kind":"json-schema","title":"PriceObject","data":{"description":"Price Object contains all values for a specific vehicle.","type":"object","properties":{"vehicle_type":{"type":"integer","example":11},"value":{"type":"number","example":407.15},"driving_time":{"type":"integer","example":23575},"estimated_loading_times":{"type":"array","items":{"$ref":"#/components/schemas/SpotTimes"}},"estimated_unloading_times":{"type":"array","items":{"$ref":"#/components/schemas/SpotTimes"}},"available_extra_services":{"type":"array","items":{"$ref":"#/components/schemas/ExtraService"}}}}},"components/schemas/PublishBookingRequest":{"id":"components/schemas/PublishBookingRequest","kind":"json-schema","title":"PublishBookingRequest","data":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Item"},{"type":"object","properties":{"name":{"type":"string","example":"Product Name"}}}]}},"vehicle_type":{"type":"integer","example":11},"additional_information":{"type":"string","example":"Attention: highly flammable goods"},"loadings":{"type":"array","items":{"$ref":"#/components/schemas/SpotAddresses"}},"unloadings":{"type":"array","items":{"$ref":"#/components/schemas/SpotAddresses"}}}}},"components/schemas/SpecialEventResponse":{"id":"components/schemas/SpecialEventResponse","kind":"json-schema","title":"SpecialEventResponse","data":{"type":"object","properties":{"message":{"type":"string","example":"Booking created successfully."},"data":{"$ref":"#/components/schemas/PublishBookingResponseData"}},"required":["message","data"]}},"components/schemas/PublishBookingResponseData":{"id":"components/schemas/PublishBookingResponseData","kind":"json-schema","title":"PublishBookingResponseData","data":{"type":"object","properties":{"id":{"type":"string","example":"68ca7c622436dd852703e2b2"},"order_number":{"type":"integer","example":200949},"items":{"type":"array","items":{"$ref":"#/components/schemas/PublishBookingResponseItem"}},"additional_information":{"type":"string","example":"Achtung leicht entzündliche Ware"},"loadings":{"type":"array","items":{"$ref":"#/components/schemas/SpotAddresses"}},"unloadings":{"type":"array","items":{"$ref":"#/components/schemas/SpotAddresses"}}},"required":["id","order_number","items","loadings","unloadings"]}},"components/schemas/PublishBookingResponseItem":{"id":"components/schemas/PublishBookingResponseItem","kind":"json-schema","title":"PublishBookingResponseItem","data":{"type":"object","properties":{"category":{"type":"string","example":"other"},"is_stackable":{"type":"boolean","example":false},"quantity":{"type":"integer","example":1},"name":{"type":"string","example":"Tannenbaum"},"weight":{"type":"integer","example":320},"length":{"type":"integer","example":120},"width":{"type":"integer","example":100},"height":{"type":"integer","example":80}}}},"components/schemas/UpdateOrderRequest":{"id":"components/schemas/UpdateOrderRequest","kind":"json-schema","title":"UpdateOrderRequest","data":{"description":"Request to update order status","type":"object","properties":{"status":{"type":"string","enum":["canceled"],"example":"canceled"}},"required":["status"]}},"components/schemas/UpdateOrderResponse":{"id":"components/schemas/UpdateOrderResponse","kind":"json-schema","title":"UpdateOrderResponse","data":{"description":"Response after updating order status","type":"object","properties":{"message":{"type":"string","example":"Success!"}},"required":["message"]}},"components/schemas/OrderStatus":{"id":"components/schemas/OrderStatus","kind":"json-schema","title":"OrderStatus","data":{"type":"string","description":"Current status of the order.","enum":["draft","placed","loaded","canceled"],"example":"placed"}},"components/schemas/OrderStop":{"id":"components/schemas/OrderStop","kind":"json-schema","title":"OrderStop","data":{"description":"Loading or unloading stop including location and time window.","type":"object","properties":{"country":{"type":"string","example":"DE"},"zip":{"type":"string","example":"22869"},"city":{"type":"string","example":"Schenefeld"},"start_date":{"type":"string","format":"date-time","example":"2025-02-10T07:00:00+01:00"},"end_date":{"type":"string","format":"date-time","example":"2025-02-10T09:00:00+01:00"}}}},"components/schemas/Order":{"id":"components/schemas/Order","kind":"json-schema","title":"Order","data":{"description":"Order summary","type":"object","properties":{"id":{"type":"string","example":"67a5f6e2cbf149fb4e0bc2d2"},"order_number":{"type":"integer","example":200151},"loadings":{"type":"array","items":{"$ref":"#/components/schemas/OrderStop"}},"unloadings":{"type":"array","items":{"$ref":"#/components/schemas/OrderStop"}},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["id","order_number","status"]}},"components/schemas/PaginationLinks":{"id":"components/schemas/PaginationLinks","kind":"json-schema","title":"PaginationLinks","data":{"type":"object","properties":{"first":{"type":"string","example":"https://app.zipmend.com/api/v3/orders?page=1"},"last":{"type":"string","example":"https://app.zipmend.com/api/v3/orders?page=1"},"prev":{"anyOf":[{"type":"string"},{"type":"null"}],"example":null},"next":{"anyOf":[{"type":"string"},{"type":"null"}],"example":null}}}},"components/schemas/PaginationLinkEntry":{"id":"components/schemas/PaginationLinkEntry","kind":"json-schema","title":"PaginationLinkEntry","data":{"type":"object","properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"example":"https://app.zipmend.com/api/v3/orders?page=1"},"label":{"type":"string","example":"1"},"active":{"type":"boolean","example":true}}}},"components/schemas/PaginationMeta":{"id":"components/schemas/PaginationMeta","kind":"json-schema","title":"PaginationMeta","data":{"type":"object","properties":{"current_page":{"type":"integer","example":1},"from":{"type":"integer","example":1},"last_page":{"type":"integer","example":1},"links":{"type":"array","items":{"$ref":"#/components/schemas/PaginationLinkEntry"}},"path":{"type":"string","example":"https://app.zipmend.com/api/v3/orders"},"per_page":{"type":"integer","example":15},"to":{"type":"integer","example":1},"total":{"type":"integer","example":1}}}},"components/schemas/GetOrdersResponse":{"id":"components/schemas/GetOrdersResponse","kind":"json-schema","title":"GetOrdersResponse","data":{"description":"List of orders with pagination data","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"links":{"$ref":"#/components/schemas/PaginationLinks"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data"]}},"components/schemas/OrderAddress":{"id":"components/schemas/OrderAddress","kind":"json-schema","title":"OrderAddress","data":{"description":"Address for a loading or unloading stop.","type":"object","properties":{"company_name":{"type":"string","example":"Acme Corporation"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"address_line_1":{"type":"string","example":"Karl-Marx-Strasse 1"},"address_line_2":{"type":"string","example":"Tor 2"},"country":{"type":"string","example":"DE"},"zip":{"type":"string","example":"28779"},"city":{"type":"string","example":"Bremen"}}}},"components/schemas/OrderStatusEntry":{"id":"components/schemas/OrderStatusEntry","kind":"json-schema","title":"OrderStatusEntry","data":{"description":"Status update for a stop or order.","type":"object","properties":{"type":{"type":"string","example":"finished"},"date":{"type":"string","format":"date-time","example":"2025-09-04T11:50:00+02:00"}}}},"components/schemas/OrderDetailedStop":{"id":"components/schemas/OrderDetailedStop","kind":"json-schema","title":"OrderDetailedStop","data":{"description":"Detailed stop including address, time windows and statuses.","type":"object","properties":{"id":{"type":"string","example":"68b9627a8fb3ff609808c844"},"dates":{"type":"array","items":{"$ref":"#/components/schemas/SpotTimes"}},"address":{"$ref":"#/components/schemas/OrderAddress"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/OrderStatusEntry"}}}}},"components/schemas/OrderGoodsItem":{"id":"components/schemas/OrderGoodsItem","kind":"json-schema","title":"OrderGoodsItem","data":{"description":"Goods item as part of an order.","type":"object","properties":{"quantity":{"type":"integer","example":1},"category":{"type":"string","example":"epal"},"name":{"type":"string","example":"Harmlose Handelsware"},"weight":{"type":"integer","example":100},"length":{"type":"integer","example":120},"width":{"type":"integer","example":80},"height":{"type":"integer","example":100},"is_stackable":{"type":"boolean","example":false}}}},"components/schemas/OrderPrice":{"id":"components/schemas/OrderPrice","kind":"json-schema","title":"OrderPrice","data":{"description":"Price information for an order.","type":"object","properties":{"net_amount":{"type":"number","example":219.82},"gross_amount":{"type":"number","example":261.59},"vat_rate":{"type":"number","example":0.19},"currency_code":{"type":"string","example":"EUR"},"transport_net_amount":{"type":"number","example":219.82}}}},"components/schemas/OrderDetail":{"id":"components/schemas/OrderDetail","kind":"json-schema","title":"OrderDetail","data":{"description":"Detailed order object","type":"object","properties":{"id":{"type":"string","example":"68b9627a8fb3ff609808c842"},"order_number":{"type":"integer","example":200887},"status":{"$ref":"#/components/schemas/OrderStatus"},"documented_delivery":{"type":"boolean","example":false},"distance":{"type":"integer","example":142},"payment_method":{"type":"string","example":"invoice"},"loadings":{"type":"array","items":{"$ref":"#/components/schemas/OrderDetailedStop"}},"unloadings":{"type":"array","items":{"$ref":"#/components/schemas/OrderDetailedStop"}},"goods":{"type":"array","items":{"$ref":"#/components/schemas/OrderGoodsItem"}},"price":{"$ref":"#/components/schemas/OrderPrice"},"extra_services":{"type":"array","items":{"$ref":"#/components/schemas/ExtraService"}}}}},"components/schemas/GetOrderByIdResponse":{"id":"components/schemas/GetOrderByIdResponse","kind":"json-schema","title":"GetOrderByIdResponse","data":{"description":"Response for fetching a single order by ID","type":"object","properties":{"message":{"type":"string","example":"Success!"},"data":{"$ref":"#/components/schemas/OrderDetail"}},"required":["message","data"]}},"schema_0":{"kind":"json-schema","data":{"type":"string","example":"8051 CP Hattem"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/OrderStatus"}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"integer","example":231231},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","example":"68b9627a8fb3ff609808c842"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","example":"68822b0ea09ba5655e0a2032"},"id":"schema_4"}},"exampleStore":{"components/examples/CreatePriceRequestExample":{"id":"components/examples/CreatePriceRequestExample","value":{"items":[{"quantity":1,"length":230,"width":120,"height":80,"weight":320}],"loadings":[{"name":"Bremen","zip_code":"28779","country":"DE"}],"unloadings":[{"name":"Bremen","zip_code":"28779","country":"DE"}],"loading_date":"2024-07-19T08:00:00+01:00","ftl_timeslot_duration":6},"description":"Example request for price calculation."},"components/examples/CreatePriceResponseExample":{"id":"components/examples/CreatePriceResponseExample","value":{"message":"Success!","data":[{"vehicle_type":11,"value":407.15,"driving_time":23575,"estimated_loading_times":[{"start":"2024-09-19T09:00:00+02:00","end":"2024-09-19T10:00:00+02:00"}],"estimated_unloading_times":[{"start":"2024-09-19T14:00:00+02:00","end":"2024-09-19T15:00:00+02:00"}],"available_extra_services":[{"label":"loadingThroughDriver","cost":29.9},{"label":"unloadingThroughDriver","cost":29.9}]},{"vehicle_type":12,"value":450,"driving_time":24000,"estimated_loading_times":[{"start":"2024-09-19T09:30:00+02:00","end":"2024-09-19T10:30:00+02:00"}],"estimated_unloading_times":[{"start":"2024-09-19T14:30:00+02:00","end":"2024-09-19T15:30:00+02:00"}],"available_extra_services":[{"label":"loadingThroughDriver","cost":34.9},{"label":"unloadingThroughDriver","cost":34.9}]}]},"summary":"Example price response"},"components/examples/PublishBookingRequestExample":{"id":"components/examples/PublishBookingRequestExample","value":{"items":[{"name":"Product Name","quantity":22,"length":120,"width":100,"height":80,"weight":320}],"vehicle_type":13,"additional_information":"Attention: highly flammable goods","loadings":[{"company_name":"Acme Corporation","first_name":"John","last_name":"Smith","address_line_1":"Karl-Marx-Strasse 1","address_line_2":"Tor 2","country":"DE","zip":"28779","city":"Bremen","phone":"+49123456789","reference_number":"123456789","dates":[{"start":"2024-07-20T07:00:00+01:00","end":"2024-07-20T10:00:00+01:00"}]}],"unloadings":[{"company_name":"zipmend GmbH","first_name":"Max","last_name":"Mustermann","address_line_1":"Steintorweg 4","address_line_2":"Tor 2","country":"DE","zip":"12247","city":"Berlin","phone":"+49123456789","reference_number":"123456789","dates":[{"start":"2024-07-20T13:50:00+01:00","end":"2024-07-20T16:50:00+01:00"}]}]},"summary":"Example booking request"},"components/examples/GetCitiesResponseExample":{"id":"components/examples/GetCitiesResponseExample","value":{"message":"Success!","data":[{"name":"Hattem","zip_code":"8051 CP","country":"NL"},{"name":"Hattem","zip_code":"8051 NL","country":"NL"},{"name":"Hattem","zip_code":"8051 AK","country":"NL"},{"name":"Hattem","zip_code":"8051 AW","country":"NL"}]},"summary":"List of cities"},"components/examples/UpdateOrderRequestExample":{"id":"components/examples/UpdateOrderRequestExample","value":{"status":"canceled"},"summary":"Example request to cancel an order"},"components/examples/UpdateOrderResponseExample":{"id":"components/examples/UpdateOrderResponseExample","value":{"message":"Success!"},"summary":"Example successful order update response"},"components/examples/GetOrdersResponseExample":{"id":"components/examples/GetOrdersResponseExample","value":{"data":[{"id":"67a5f6e2cbf149fb4e0bc2d2","order_number":200151,"loadings":[{"country":"DE","zip":"22869","city":"Schenefeld","start_date":"2025-02-10T07:00:00+01:00","end_date":"2025-02-10T09:00:00+01:00"}],"unloadings":[{"country":"DE","zip":"02829","city":"Königshain","start_date":"2025-02-10T15:50:00+01:00","end_date":"2025-02-10T17:50:00+01:00"}],"status":"placed"}],"links":{"first":"https://app.zipmend.com/api/v3/orders?page=1","last":"https://app.zipmend.com/api/v3/orders?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"https://app.zipmend.com/api/v3/orders?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"https://app.zipmend.com/api/v3/orders","per_page":15,"to":1,"total":1}},"summary":"Example orders list with filters"},"components/examples/GetOrderByIdResponseExample":{"id":"components/examples/GetOrderByIdResponseExample","value":{"message":"Success!","data":{"id":"68b9627a8fb3ff609808c842","order_number":200887,"status":"loaded","documented_delivery":false,"distance":142,"payment_method":"invoice","loadings":[{"id":"68b9627a8fb3ff609808c844","dates":[{"start":"2025-09-04T12:00:00+02:00","end":"2025-09-04T14:00:00+02:00"}],"address":{"company_name":"Acme Corporation","first_name":"John","last_name":"Smith","address_line_1":"Karl-Marx-Strasse 1","address_line_2":"Tor 2","country":"DE","zip":"28779","city":"Bremen"},"statuses":[{"type":"finished","date":"2025-09-04T11:50:00+02:00"}]}],"unloadings":[{"id":"68b9627b8fb3ff609808c846","dates":[{"start":"2025-09-04T14:40:00+02:00","end":"2025-09-04T16:40:00+02:00"}],"address":{"company_name":"Mike Kolbe Heizungstechnik GmbH","first_name":"Mike","last_name":"Kolbe","address_line_1":"Dannenkamp 4","address_line_2":"3. OG","country":"DE","zip":"22869","city":"Schenefeld"},"statuses":[]}],"goods":[{"quantity":1,"category":"epal","name":"Harmlose Handelsware","weight":100,"length":120,"width":80,"height":100,"is_stackable":false}],"price":{"net_amount":219.82,"gross_amount":261.59,"vat_rate":0.19,"currency_code":"EUR","transport_net_amount":219.82},"extra_services":[]}},"summary":"Example response for a single order by ID"},"paths/~1cities/get/responses/200/content/application~1json/examples/default_example":{"value":{"message":"Success!","data":[{"name":"Hattem","zip_code":"8051 CP","country":"NL"},{"name":"Hattem","zip_code":"8051 NL","country":"NL"},{"name":"Hattem","zip_code":"8051 AK","country":"NL"},{"name":"Hattem","zip_code":"8051 AW","country":"NL"}]},"key":"default_example","summary":"List of cities","id":"paths/~1cities/get/responses/200/content/application~1json/examples/default_example"},"paths/~1cities/get/responses/401/content/application~1json/examples/unauthorized_example":{"value":{"message":"Unauthenticated!","errors":{}},"key":"unauthorized_example","summary":"Unauthenticated","id":"paths/~1cities/get/responses/401/content/application~1json/examples/unauthorized_example"},"paths/~1price/post/requestBody/content/application~1json/examples/default_example":{"value":{"items":[{"quantity":1,"length":230,"width":120,"height":80,"weight":320}],"loadings":[{"name":"Bremen","zip_code":"28779","country":"DE"}],"unloadings":[{"name":"Bremen","zip_code":"28779","country":"DE"}],"loading_date":"2024-07-19T08:00:00+01:00","ftl_timeslot_duration":6},"key":"default_example","summary":"default_example","description":"Example request for price calculation.","id":"paths/~1price/post/requestBody/content/application~1json/examples/default_example"},"paths/~1price/post/responses/200/content/application~1json/examples/default_example":{"value":{"message":"Success!","data":[{"vehicle_type":11,"value":407.15,"driving_time":23575,"estimated_loading_times":[{"start":"2024-09-19T09:00:00+02:00","end":"2024-09-19T10:00:00+02:00"}],"estimated_unloading_times":[{"start":"2024-09-19T14:00:00+02:00","end":"2024-09-19T15:00:00+02:00"}],"available_extra_services":[{"label":"loadingThroughDriver","cost":29.9},{"label":"unloadingThroughDriver","cost":29.9}]},{"vehicle_type":12,"value":450,"driving_time":24000,"estimated_loading_times":[{"start":"2024-09-19T09:30:00+02:00","end":"2024-09-19T10:30:00+02:00"}],"estimated_unloading_times":[{"start":"2024-09-19T14:30:00+02:00","end":"2024-09-19T15:30:00+02:00"}],"available_extra_services":[{"label":"loadingThroughDriver","cost":34.9},{"label":"unloadingThroughDriver","cost":34.9}]}]},"key":"default_example","summary":"Example price response","id":"paths/~1price/post/responses/200/content/application~1json/examples/default_example"},"paths/~1price/post/responses/401/content/application~1json/examples/unauthorized_example":{"value":{"message":"Unauthenticated!","errors":{}},"key":"unauthorized_example","summary":"Unauthenticated","id":"paths/~1price/post/responses/401/content/application~1json/examples/unauthorized_example"},"paths/~1price/post/responses/422/content/application~1json/examples/price_error_example":{"value":{"message":"The given data was invalid.","errors":{"loadings":["Das Feld loadings ist erforderlich."],"unloadings":["Das Feld unloadings ist erforderlich."],"loading_date":["Das Feld loading date ist erforderlich."]}},"key":"price_error_example","summary":"Price calculation error response","id":"paths/~1price/post/responses/422/content/application~1json/examples/price_error_example"},"paths/~1booking~1publish/post/requestBody/content/application~1json/examples/default_example":{"value":{"items":[{"name":"Product Name","quantity":22,"length":120,"width":100,"height":80,"weight":320}],"vehicle_type":13,"additional_information":"Attention: highly flammable goods","loadings":[{"company_name":"Acme Corporation","first_name":"John","last_name":"Smith","address_line_1":"Karl-Marx-Strasse 1","address_line_2":"Tor 2","country":"DE","zip":"28779","city":"Bremen","phone":"+49123456789","reference_number":"123456789","dates":[{"start":"2024-07-20T07:00:00+01:00","end":"2024-07-20T10:00:00+01:00"}]}],"unloadings":[{"company_name":"zipmend GmbH","first_name":"Max","last_name":"Mustermann","address_line_1":"Steintorweg 4","address_line_2":"Tor 2","country":"DE","zip":"12247","city":"Berlin","phone":"+49123456789","reference_number":"123456789","dates":[{"start":"2024-07-20T13:50:00+01:00","end":"2024-07-20T16:50:00+01:00"}]}]},"key":"default_example","summary":"Example booking request","id":"paths/~1booking~1publish/post/requestBody/content/application~1json/examples/default_example"},"paths/~1booking~1publish/post/responses/200/content/application~1json/examples/publish_success_example":{"value":{"message":"Success!","data":{"id":"68ca7c622436dd852703e2b2","order_number":200949,"items":[{"category":"other","is_stackable":false,"quantity":1,"name":"Tannenbaum","weight":320,"length":120,"width":100,"height":80}],"additional_information":"Achtung leicht entzündliche Ware","loadings":[{"company_name":"Acme Corporation","first_name":"John","last_name":"Smith","address_line_1":"Karl-Marx-Strasse 1","address_line_2":"Tor 2","country":"DE","zip":"28779","city":"Bremen","phone":"+49123456789","reference_number":"123456789","dates":[{"start":"2025-09-18T17:00:00+02:00","end":"2025-09-18T19:00:00+02:00"}]}],"unloadings":[{"company_name":"zipmend GmbH","first_name":"Max","last_name":"Mustermann","address_line_1":"Steintorweg 4","address_line_2":"Tor 2","country":"DE","zip":"12247","city":"Berlin","phone":"+49123456789","reference_number":"123456789","dates":[{"start":"2025-09-18T19:50:00+02:00","end":"2025-09-18T20:50:00+02:00"}]}]}},"key":"publish_success_example","summary":"Successful booking response","id":"paths/~1booking~1publish/post/responses/200/content/application~1json/examples/publish_success_example"},"paths/~1booking~1publish/post/responses/401/content/application~1json/examples/unauthorized_example":{"value":{"message":"Unauthenticated!","errors":{}},"key":"unauthorized_example","summary":"Unauthenticated","id":"paths/~1booking~1publish/post/responses/401/content/application~1json/examples/unauthorized_example"},"paths/~1booking~1publish/post/responses/422/content/application~1json/examples/publish_error_example":{"value":{"message":"Loading start date must be equal to or after than current date + 0:00 hours (and 3 more errors)","errors":{"date_errors":["Loading start date must be equal to or after than current date + 0:00 hours","Loading end date must be equal to or after than current date + 2:00 hours"],"validation_errors":["Unloading start date (2025-04-04T14:50:00+02:00) should't be before loading start date + driving time (04.04.2025 18:44:00)","Unloading end date (2025-04-04T17:50:00+02:00) shouldn't be before loading end date + driving time (04.04.2025 20:44:00)"]}},"key":"publish_error_example","summary":"Publish error response","id":"paths/~1booking~1publish/post/responses/422/content/application~1json/examples/publish_error_example"},"paths/~1orders/get/responses/200/content/application~1json/examples/default_example":{"value":{"data":[{"id":"67a5f6e2cbf149fb4e0bc2d2","order_number":200151,"loadings":[{"country":"DE","zip":"22869","city":"Schenefeld","start_date":"2025-02-10T07:00:00+01:00","end_date":"2025-02-10T09:00:00+01:00"}],"unloadings":[{"country":"DE","zip":"02829","city":"Königshain","start_date":"2025-02-10T15:50:00+01:00","end_date":"2025-02-10T17:50:00+01:00"}],"status":"placed"}],"links":{"first":"https://app.zipmend.com/api/v3/orders?page=1","last":"https://app.zipmend.com/api/v3/orders?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"https://app.zipmend.com/api/v3/orders?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"https://app.zipmend.com/api/v3/orders","per_page":15,"to":1,"total":1}},"key":"default_example","summary":"Example orders list with filters","id":"paths/~1orders/get/responses/200/content/application~1json/examples/default_example"},"paths/~1orders/get/responses/401/content/application~1json/examples/unauthorized_example":{"value":{"message":"Unauthenticated!","errors":{}},"key":"unauthorized_example","summary":"Unauthenticated","id":"paths/~1orders/get/responses/401/content/application~1json/examples/unauthorized_example"},"paths/~1orders~1{orderID}/get/responses/200/content/application~1json/examples/default_example":{"value":{"message":"Success!","data":{"id":"68b9627a8fb3ff609808c842","order_number":200887,"status":"loaded","documented_delivery":false,"distance":142,"payment_method":"invoice","loadings":[{"id":"68b9627a8fb3ff609808c844","dates":[{"start":"2025-09-04T12:00:00+02:00","end":"2025-09-04T14:00:00+02:00"}],"address":{"company_name":"Acme Corporation","first_name":"John","last_name":"Smith","address_line_1":"Karl-Marx-Strasse 1","address_line_2":"Tor 2","country":"DE","zip":"28779","city":"Bremen"},"statuses":[{"type":"finished","date":"2025-09-04T11:50:00+02:00"}]}],"unloadings":[{"id":"68b9627b8fb3ff609808c846","dates":[{"start":"2025-09-04T14:40:00+02:00","end":"2025-09-04T16:40:00+02:00"}],"address":{"company_name":"Mike Kolbe Heizungstechnik GmbH","first_name":"Mike","last_name":"Kolbe","address_line_1":"Dannenkamp 4","address_line_2":"3. OG","country":"DE","zip":"22869","city":"Schenefeld"},"statuses":[]}],"goods":[{"quantity":1,"category":"epal","name":"Harmlose Handelsware","weight":100,"length":120,"width":80,"height":100,"is_stackable":false}],"price":{"net_amount":219.82,"gross_amount":261.59,"vat_rate":0.19,"currency_code":"EUR","transport_net_amount":219.82},"extra_services":[]}},"key":"default_example","summary":"Example response for a single order by ID","id":"paths/~1orders~1{orderID}/get/responses/200/content/application~1json/examples/default_example"},"paths/~1orders~1{orderID}/get/responses/401/content/application~1json/examples/unauthorized_example":{"value":{"message":"Unauthenticated!","errors":{}},"key":"unauthorized_example","summary":"Unauthenticated","id":"paths/~1orders~1{orderID}/get/responses/401/content/application~1json/examples/unauthorized_example"},"paths/~1orders~1{orderID}/get/responses/404/content/application~1json/examples/order_not_found_example":{"value":{"message":"Order not found"},"key":"order_not_found_example","summary":"Order not found","id":"paths/~1orders~1{orderID}/get/responses/404/content/application~1json/examples/order_not_found_example"},"paths/~1orders~1{orderID}/put/requestBody/content/application~1json/examples/cancel_order_example":{"value":{"status":"canceled"},"key":"cancel_order_example","summary":"Example request to cancel an order","id":"paths/~1orders~1{orderID}/put/requestBody/content/application~1json/examples/cancel_order_example"},"paths/~1orders~1{orderID}/put/responses/200/content/application~1json/examples/update_success_example":{"value":{"message":"Success!"},"key":"update_success_example","summary":"Example successful order update response","id":"paths/~1orders~1{orderID}/put/responses/200/content/application~1json/examples/update_success_example"},"paths/~1orders~1{orderID}/put/responses/401/content/application~1json/examples/unauthorized_example":{"value":{"message":"Unauthenticated!","errors":{}},"key":"unauthorized_example","summary":"Unauthenticated","id":"paths/~1orders~1{orderID}/put/responses/401/content/application~1json/examples/unauthorized_example"},"paths/~1orders~1{orderID}/put/responses/403/content/application~1json/examples/ownership_error_example":{"value":{"message":"Not allowed"},"key":"ownership_error_example","summary":"Ownership condition not respected","id":"paths/~1orders~1{orderID}/put/responses/403/content/application~1json/examples/ownership_error_example"},"paths/~1orders~1{orderID}/put/responses/404/content/application~1json/examples/order_not_found_example":{"value":{"message":"Order not found"},"key":"order_not_found_example","summary":"Order not found","id":"paths/~1orders~1{orderID}/put/responses/404/content/application~1json/examples/order_not_found_example"},"paths/~1orders~1{orderID}/put/responses/409/content/application~1json/examples/cancellation_window_expired_example":{"value":{"message":"Cancellation window expired"},"key":"cancellation_window_expired_example","summary":"Cancellation window expired","id":"paths/~1orders~1{orderID}/put/responses/409/content/application~1json/examples/cancellation_window_expired_example"},"paths/~1orders~1{orderID}/put/responses/409/content/application~1json/examples/order_status_error_example":{"value":{"message":"Order not in draft or placed status"},"key":"order_status_error_example","summary":"Order not in draft or placed status","id":"paths/~1orders~1{orderID}/put/responses/409/content/application~1json/examples/order_status_error_example"},"paths/~1orders~1{orderID}/put/responses/422/content/application~1json/examples/update_error_example":{"value":{"message":"The given data was invalid.","errors":{"status":["The selected status is invalid."]}},"key":"update_error_example","summary":"Update order error response","id":"paths/~1orders~1{orderID}/put/responses/422/content/application~1json/examples/update_error_example"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://app.zipmend.com/api/v3","description":"Production server (uses live data)"},{"url":"https://sandbox.app.zipmend.com/api/v3","description":"Sandbox server (uses test data)"}],"specType":"openapi"},"options":{"jsonSamplesExpandLevel":"all","mockServer":{"url":"/_mock/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"zipmend API","description":"Documentation for the zipmend API"}},"baseSlug":"/openapi","routesMapping":{}}