https://developer.mittwald.de/de/assets/js/38a31754.1aab9525.js

1"use strict";(self.webpackChunkapi_docs=self.webpackChunkapi_docs||[]).push([[1529],{84572:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>d,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"reference/contract/order-list-customer-orders","title":"Get list of Orders of a Customer","description":"The list of Orders of a Customer the User has access to, can be filtered by orderStatus, articleTemplate and count.","source":"@site/docs/reference/contract/order-list-customer-orders.mdx","sourceDirName":"reference/contract","slug":"/reference/contract/order-list-customer-orders","permalink":"/de/docs/v2/reference/contract/order-list-customer-orders","draft":false,"unlisted":false,"editUrl":"https://github.com/mittwald/developer-portal/tree/master/docs/reference/contract/order-list-customer-orders.mdx","tags":[],"version":"current","frontMatter":{"title":"Get list of Orders of a Customer","description":"The list of Orders of a Customer the User has access to, can be filtered by orderStatus, articleTemplate and count.","openapi":{"method":"get"}},"sidebar":"apiSidebar","previous":{"title":"Return the Contract for the given LeadFyndrProfile","permalink":"/de/docs/v2/reference/contract/contract-get-detail-of-contract-by-lead-fyndr"},"next":{"title":"Return the Contract for the given Domain","permalink":"/de/docs/v2/reference/contract/contract-get-detail-of-contract-by-domain"}}');var a=r(74848),s=r(28453),n=r(82390),p=r(45676),m=r(84990);r(20570),r(50776),r(36413),r(21481),r(19365);const o={title:"Get list of Orders of a Customer",description:"The list of Orders of a Customer the User has access to, can be filtered by orderStatus, articleTemplate and count.",openapi:{method:"get"}},d=void 0,u={},c=[{value:"Request",id:"request",level:2},{value:"Responses",id:"responses",level:2},{value:"Usage examples",id:"usage-examples",level:2}];function y(e){const t={h2:"h2",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(p.X,{path:"/v2/customers/{customerId}/orders",method:"get",spec:{operationId:"order-list-customer-orders",description:"The list of Orders of a Customer the User has access to, can be filtered by orderStatus, articleTemplate and count.",parameters:[{examples:{shortId:{value:"1000026"},uuid:{value:"13eac206-ada6-4ac8-a4c0-21b263df6cbf"}},in:"path",name:"customerId",required:!0,schema:{type:"string"}},{example:1e3,in:"query",name:"limit",required:!1,schema:{minimum:0,type:"integer"}},{example:0,in:"query",name:"skip",required:!1,schema:{minimum:0,type:"integer"}},{example:1,in:"query",name:"page",required:!1,schema:{minimum:0,type:"integer"}},{example:[],in:"query",name:"includesStatus",required:!1,schema:{items:{enum:["NEW","CONFIRMED","REJECTED","ABORTED","EXECUTED"],type:"string"},type:"array"}},{example:[],in:"query",name:"excludesStatus",required:!1,schema:{items:{enum:["NEW","CONFIRMED","REJECTED","ABORTED","EXECUTED"],type:"string"},type:"array"}},{example:["Webhosting"],in:"query",name:"templateNames",required:!1,schema:{items:{type:"string"},type:"array"}}],responses:{200:{content:{"application/json":{schema:{items:{properties:{contractChangeContractId:{format:"uuid",type:"string"},customerId:{example:"4317f5c5-1ea8-4084-a9f1-3a8e7e1c94ff",minLength:1,type:"string"},dueDate:{format:"date-time",type:"string"},invoicingPeriod:{description:"Invoicing period in months",example:12,type:"number"},items:{items:{properties:{addons:{items:{properties:{hidden:{type:"boolean"},key:{type:"string"},value:{type:"string"}},required:["key","value"],type:"object"},type:"array"},articleId:{example:"WH25-0007",type:"string"},articleName:{example:"Webhosting",type:"string"},articleTemplateName:{example:"Webhosting",type:"string"},attributeConfiguration:{items:{properties:{key:{example:"storage",type:"string"},value:{example:"10",type:"string"}},required:["key"],type:"object"},type:"array"},isInclusive:{type:"boolean"},orderItemId:{format:"uuid",type:"string"},predefinedDomainAggregateId:{example:"aa38d836-fe72-4c43-aad3-9472b51edf61",type:"string"},price:{example:1300,type:"number"},reference:{properties:{contractItemId:{format:"uuid",type:"string"},offerItemId:{format:"uuid",type:"string"},orderItemId:{format:"uuid",type:"string"}},type:"object"}},required:["orderItemId","articleId","price","isInclusive"],type:"object"},type:"array"},orderDate:{format:"date-time",type:"string"},orderId:{format:"uuid",type:"string"},orderNumber:{example:"5XXXXXX",minLength:1,type:"string"},profile:{properties:{email:{format:"email",type:"string"},firstName:{example:"Ada",type:"string"},lastName:{example:"Lovelace",type:"string"},title:{deprecated:!0,description:"the users title",enum:["other","mr","ms"],type:"string"},userId:{format:"uuid",type:"string"}},required:["userId","email"],type:"object"},status:{enum:["NEW","CONFIRMED","REJECTED","ABORTED","EXECUTED"],type:"string"},summary:{properties:{nonRecurring:{example:1e3,type:"number"},recurring:{example:9e3,type:"number"},summary:{description:"The total price of the order",example:1e4,type:"number"}}

1,required:["summary","recurring","nonRecurring"],type:"object"},type:{enum:["NEW_ORDER","CONTRACT_CHANGE"],type:"string"}},required:["orderId","orderNumber","summary","customerId","invoicingPeriod","type","status","items"],type:"object"},type:"array"}}},description:""},429:{description:"Your request ran into a rate limit. You have to wait until rate limit expires\n",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string",example:"too many requests"},type:{type:"string",example:"RateLimitError"}}}}}},default:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}}},security:[{"de.mittwald.v1.commons.AccessToken":[]}],summary:"Get list of Orders of a Customer.",tags:["Contract"]},baseURL:"https://api.mittwald.de/v2",withDescription:!0}),"\n",(0,a.jsx)(t.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(n.Xy,{spec:{operationId:"order-list-customer-orders",description:"The list of Orders of a Customer the User has access to, can be filtered by orderStatus, articleTemplate and count.",parameters:[{examples:{shortId:{value:"1000026"},uuid:{value:"13eac206-ada6-4ac8-a4c0-21b263df6cbf"}},in:"path",name:"customerId",required:!0,schema:{type:"string"}},{example:1e3,in:"query",name:"limit",required:!1,schema:{minimum:0,type:"integer"}},{example:0,in:"query",name:"skip",required:!1,schema:{minimum:0,type:"integer"}},{example:1,in:"query",name:"page",required:!1,schema:{minimum:0,type:"integer"}},{example:[],in:"query",name:"includesStatus",required:!1,schema:{items:{enum:["NEW","CONFIRMED","REJECTED","ABORTED","EXECUTED"],type:"string"},type:"array"}},{example:[],in:"query",name:"excludesStatus",required:!1,schema:{items:{enum:["NEW","CONFIRMED","REJECTED","ABORTED","EXECUTED"],type:"string"},type:"array"}},{example:["Webhosting"],in:"query",name:"templateNames",required:!1,schema:{items:{type:"string"},type:"array"}}],responses:{200:{content:{"application/json":{schema:{items:{properties:{contractChangeContractId:{format:"uuid",type:"string"},customerId:{example:"4317f5c5-1ea8-4084-a9f1-3a8e7e1c94ff",minLength:1,type:"string"},dueDate:{format:"date-time",type:"string"},invoicingPeriod:{description:"Invoicing period in months",example:12,type:"number"},items:{items:{properties:{addons:{items:{properties:{hidden:{type:"boolean"},key:{type:"string"},value:{type:"string"}},required:["key","value"],type:"object"},type:"array"},articleId:{example:"WH25-0007",type:"string"},articleName:{example:"Webhosting",type:"string"},articleTemplateName:{example:"Webhosting",type:"string"},attributeConfiguration:{items:{properties:{key:{example:"storage",type:"string"},value:{example:"10",type:"string"}},required:["key"],type:"object"},type:"array"},isInclusive:{type:"boolean"},orderItemId:{format:"uuid",type:"string"},predefinedDomainAggregateId:{example:"aa38d836-fe72-4c43-aad3-9472b51edf61",type:"string"},price:{example:1300,type:"number"},reference:{properties:{contractItemId:{format:"uuid",type:"string"},offerItemId:{format:"uuid",type:"string"},orderItemId:{format:"uuid",type:"string"}},type:"object"}},required:["orderItemId","articleId","price","isInclusive"],type:"object"},type:"array"},orderDate:{format:"date-time",type:"string"},orderId:{format:"uuid",type:"string"},orderNumber:{example:"5XXXXXX",minLength:1,type:"string"},profile:{properties:{email:{format:"email",type:"string"},firstName:{example:"Ada",type:"string"},lastName:{example:"Lovelace",type:"string"},title:{deprecated:!0,description:"the users title",enum:["other","mr","ms"],type:"string"},userId:{format:"uuid",type:"string"}},required:["userId","email"],type:"object"},status:{enum:["NEW","CONFIRMED","REJECTED","ABORTED","EXECUTED"],type:"string"},summary:{properties:{nonRecurring:{example:1e3,type:"number"},recurring:{example:9e3,type:"number"},summary:{description:"The total price of the order",example:1e4,type:"number"}}

1,required:["summary","recurring","nonRecurring"],type:"object"},type:{enum:["NEW_ORDER","CONTRACT_CHANGE"],type:"string"}},required:["orderId","orderNumber","summary","customerId","invoicingPeriod","type","status","items"],type:"object"},type:"array"}}},description:""},429:{description:"Your request ran into a rate limit. You have to wait until rate limit expires\n",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string",example:"too many requests"},type:{type:"string",example:"RateLimitError"}}}}}},default:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}}},security:[{"de.mittwald.v1.commons.AccessToken":[]}],summary:"Get list of Orders of a Customer.",tags:["Contract"]}}),"\n",(0,a.jsx)(t.h2,{id:"responses",children:"Responses"}),"\n",(0,a.jsx)(n.SL,{spec:{operationId:"order-list-customer-orders",description:"The list of Orders of a Customer the User has access to, can be filtered by orderStatus, articleTemplate and count.",parameters:[{examples:{shortId:{value:"1000026"},uuid:{value:"13eac206-ada6-4ac8-a4c0-21b263df6cbf"}},in:"path",name:"customerId",required:!0,schema:{type:"string"}},{example:1e3,in:"query",name:"limit",required:!1,schema:{minimum:0,type:"integer"}},{example:0,in:"query",name:"skip",required:!1,schema:{minimum:0,type:"integer"}},{example:1,in:"query",name:"page",required:!1,schema:{minimum:0,type:"integer"}},{example:[],in:"query",name:"includesStatus",required:!1,schema:{items:{enum:["NEW","CONFIRMED","REJECTED","ABORTED","EXECUTED"],type:"string"},type:"array"}},{example:[],in:"query",name:"excludesStatus",required:!1,schema:{items:{enum:["NEW","CONFIRMED","REJECTED","ABORTED","EXECUTED"],type:"string"},type:"array"}},{example:["Webhosting"],in:"query",name:"templateNames",required:!1,schema:{items:{type:"string"},type:"array"}}],responses:{200:{content:{"application/json":{schema:{items:{properties:{contractChangeContractId:{format:"uuid",type:"string"},customerId:{example:"4317f5c5-1ea8-4084-a9f1-3a8e7e1c94ff",minLength:1,type:"string"},dueDate:{format:"date-time",type:"string"},invoicingPeriod:{description:"Invoicing period in months",example:12,type:"number"},items:{items:{properties:{addons:{items:{properties:{hidden:{type:"boolean"},key:{type:"string"},value:{type:"string"}},required:["key","value"],type:"object"},type:"array"},articleId:{example:"WH25-0007",type:"string"},articleName:{example:"Webhosting",type:"string"},articleTemplateName:{example:"Webhosting",type:"string"},attributeConfiguration:{items:{properties:{key:{example:"storage",type:"string"},value:{example:"10",type:"string"}},required:["key"],type:"object"},type:"array"},isInclusive:{type:"boolean"},orderItemId:{format:"uuid",type:"string"},predefinedDomainAggregateId:{example:"aa38d836-fe72-4c43-aad3-9472b51edf61",type:"string"},price:{example:1300,type:"number"},reference:{properties:{contractItemId:{format:"uuid",type:"string"},offerItemId:{format:"uuid",type:"string"},orderItemId:{format:"uuid",type:"string"}},type:"object"}},required:["orderItemId","articleId","price","isInclusive"],type:"object"},type:"array"},orderDate:{format:"date-time",type:"string"},orderId:{format:"uuid",type:"string"},orderNumber:{example:"5XXXXXX",minLength:1,type:"string"},profile:{properties:{email:{format:"email",type:"string"},firstName:{example:"Ada",type:"string"},lastName:{example:"Lovelace",type:"string"},title:{deprecated:!0,description:"the users title",enum:["other","mr","ms"],type:"string"},userId:{format:"uuid",type:"string"}},required:["userId","email"],type:"object"},status:{enum:["NEW","CONFIRMED","REJECTED","ABORTED","EXECUTED"],type:"string"},summary:{properties:{nonRecurring:{example:1e3,type:"number"},recurring:{example:9e3,type:"number"},summary:{description:"The total price of the order",example:1e4,type:"number"}},required:["summary","recurring","nonRecurring"],type:"object"},type:{enum:["NEW_ORDER","CONTRACT_CHANGE"],type:"string"}},required:["orderId","orderNumber","summary","customerId","invoicingPerio

1d","type","status","items"],type:"object"},type:"array"}}},description:""},429:{description:"Your request ran into a rate limit. You have to wait until rate limit expires\n",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string",example:"too many requests"},type:{type:"string",example:"RateLimitError"}}}}}},default:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}}},security:[{"de.mittwald.v1.commons.AccessToken":[]}],summary:"Get list of Orders of a Customer.",tags:["Contract"]}}),"\n",(0,a.jsx)(t.h2,{id:"usage-examples",children:"Usage examples"}),"\n",(0,a.jsx)(m.t,{method:"get",url:"/v2/customers/{customerId}/orders",spec:{operationId:"order-list-customer-orders",description:"The list of Orders of a Customer the User has access to, can be filtered by orderStatus, articleTemplate and count.",parameters:[{examples:{shortId:{value:"1000026"},uuid:{value:"13eac206-ada6-4ac8-a4c0-21b263df6cbf"}},in:"path",name:"customerId",required:!0,schema:{type:"string"}},{example:1e3,in:"query",name:"limit",required:!1,schema:{minimum:0,type:"integer"}},{example:0,in:"query",name:"skip",required:!1,schema:{minimum:0,type:"integer"}},{example:1,in:"query",name:"page",required:!1,schema:{minimum:0,type:"integer"}},{example:[],in:"query",name:"includesStatus",required:!1,schema:{items:{enum:["NEW","CONFIRMED","REJECTED","ABORTED","EXECUTED"],type:"string"},type:"array"}},{example:[],in:"query",name:"excludesStatus",required:!1,schema:{items:{enum:["NEW","CONFIRMED","REJECTED","ABORTED","EXECUTED"],type:"string"},type:"array"}},{example:["Webhosting"],in:"query",name:"templateNames",required:!1,schema:{items:{type:"string"},type:"array"}}],responses:{200:{content:{"application/json":{schema:{items:{properties:{contractChangeContractId:{format:"uuid",type:"string"},customerId:{example:"4317f5c5-1ea8-4084-a9f1-3a8e7e1c94ff",minLength:1,type:"string"},dueDate:{format:"date-time",type:"string"},invoicingPeriod:{description:"Invoicing period in months",example:12,type:"number"},items:{items:{properties:{addons:{items:{properties:{hidden:{type:"boolean"},key:{type:"string"},value:{type:"string"}},required:["key","value"],type:"object"},type:"array"},articleId:{example:"WH25-0007",type:"string"},articleName:{example:"Webhosting",type:"string"},articleTemplateName:{example:"Webhosting",type:"string"},attributeConfiguration:{items:{properties:{key:{example:"storage",type:"string"},value:{example:"10",type:"string"}},required:["key"],type:"object"},type:"array"},isInclusive:{type:"boolean"},orderItemId:{format:"uuid",type:"string"},predefinedDomainAggregateId:{example:"aa38d836-fe72-4c43-aad3-9472b51edf61",type:"string"},price:{example:1300,type:"number"},reference:{properties:{contractItemId:{format:"uuid",type:"string"},offerItemId:{format:"uuid",type:"string"},orderItemId:{format:"uuid",type:"string"}},type:"object"}},required:["orderItemId","articleId","price","isInclusive"],type:"object"},type:"array"},orderDate:{format:"date-time",type:"string"},orderId:{format:"uuid",type:"string"},orderNumber:{example:"5XXXXXX",minLength:1,type:"string"},profile:{properties:{email:{format:"email",type:"string"},firstName:{example:"Ada",type:"string"},lastName:{example:"Lovelace",type:"string"},title:{deprecated:!0,description:"the users title",enum:["other","mr","ms"],type:"string"},userId:{format:"uuid",type:"string"}},required:["userId","email"],type:"object"},status:{enum:["NEW","CONFIRMED","REJECTED","ABORTED","EXECUTED"],type:"string"},summary:{properties:{nonRecurring:{example:1e3,type:"number"},recurring:{example:9e3,type:"number"},summary:{description:"The total price of the order",example:1e4,type:"number"}},required:["summary","recurring","nonRecurring"],type:"object"},type:{enum:["NEW_ORDER","CONTRACT_CHANGE"],type:"string"}},required:["orderId","orderNumber","summary","customerId","invoicingPerio

1d","type","status","items"],type:"object"},type:"array"}}},description:""},429:{description:"Your request ran into a rate limit. You have to wait until rate limit expires\n",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string",example:"too many requests"},type:{type:"string",example:"RateLimitError"}}}}}},default:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}}},security:[{"de.mittwald.v1.commons.AccessToken":[]}],summary:"Get list of Orders of a Customer.",tags:["Contract"]},baseURL:"https://api.mittwald.de/v2",withJavascript:!0,withPHP:!0})]})}function l(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(y,{...e})}):y(e)}}}]);