POST api/Order/CreateOrderHead

Creates the order head.

Access

Requires authentication.

Requires SSL.

Request Information

Parameters

NameDescriptionAdditional information
orderHead 
The order head.

Define this parameter in the request body.

Request body formats

application/xml, text/xml

Sample: 
<OrderHead xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Id>1</Id>
  <Readonly>true</Readonly>
  <ProjectId>1</ProjectId>
  <ExternalCode>sample string 2</ExternalCode>
  <WishedDeliveryDate>2025-04-29T15:13:07.7630083+02:00</WishedDeliveryDate>
  <ExternalOrderNumber>sample string 3</ExternalOrderNumber>
  <HeaderText>sample string 4</HeaderText>
  <OrderLines>
    <OrderLine>
      <Id>1</Id>
      <Readonly>true</Readonly>
      <ArticleId>1</ArticleId>
      <CutAndBendDefinitionId>1</CutAndBendDefinitionId>
      <MeshDefinitionId>1</MeshDefinitionId>
      <WeldDefinitionId>1</WeldDefinitionId>
      <ArticleDefinitionId>1</ArticleDefinitionId>
      <ConfigElementDefinitionId>1</ConfigElementDefinitionId>
      <Amount>1</Amount>
      <GroupCount>1</GroupCount>
      <IsPieceUnit>true</IsPieceUnit>
    </OrderLine>
    <OrderLine>
      <Id>1</Id>
      <Readonly>true</Readonly>
      <ArticleId>1</ArticleId>
      <CutAndBendDefinitionId>1</CutAndBendDefinitionId>
      <MeshDefinitionId>1</MeshDefinitionId>
      <WeldDefinitionId>1</WeldDefinitionId>
      <ArticleDefinitionId>1</ArticleDefinitionId>
      <ConfigElementDefinitionId>1</ConfigElementDefinitionId>
      <Amount>1</Amount>
      <GroupCount>1</GroupCount>
      <IsPieceUnit>true</IsPieceUnit>
    </OrderLine>
    <OrderLine>
      <Id>1</Id>
      <Readonly>true</Readonly>
      <ArticleId>1</ArticleId>
      <CutAndBendDefinitionId>1</CutAndBendDefinitionId>
      <MeshDefinitionId>1</MeshDefinitionId>
      <WeldDefinitionId>1</WeldDefinitionId>
      <ArticleDefinitionId>1</ArticleDefinitionId>
      <ConfigElementDefinitionId>1</ConfigElementDefinitionId>
      <Amount>1</Amount>
      <GroupCount>1</GroupCount>
      <IsPieceUnit>true</IsPieceUnit>
    </OrderLine>
  </OrderLines>
</OrderHead>

application/json, text/json

Sample: 
{
  "OrderLines": [
    {
      "ArticleId": 1,
      "CutAndBendDefinitionId": 1,
      "MeshDefinitionId": 1,
      "WeldDefinitionId": 1,
      "ArticleDefinitionId": 1,
      "ConfigElementDefinitionId": 1,
      "Amount": 1.0,
      "GroupCount": 1,
      "IsPieceUnit": true,
      "Id": 1,
      "Readonly": true
    },
    {
      "ArticleId": 1,
      "CutAndBendDefinitionId": 1,
      "MeshDefinitionId": 1,
      "WeldDefinitionId": 1,
      "ArticleDefinitionId": 1,
      "ConfigElementDefinitionId": 1,
      "Amount": 1.0,
      "GroupCount": 1,
      "IsPieceUnit": true,
      "Id": 1,
      "Readonly": true
    },
    {
      "ArticleId": 1,
      "CutAndBendDefinitionId": 1,
      "MeshDefinitionId": 1,
      "WeldDefinitionId": 1,
      "ArticleDefinitionId": 1,
      "ConfigElementDefinitionId": 1,
      "Amount": 1.0,
      "GroupCount": 1,
      "IsPieceUnit": true,
      "Id": 1,
      "Readonly": true
    }
  ],
  "ProjectId": 1,
  "ExternalCode": "sample string 2",
  "WishedDeliveryDate": "2025-04-29T15:13:07.7630083+02:00",
  "ExternalOrderNumber": "sample string 3",
  "HeaderText": "sample string 4",
  "Id": 1,
  "Readonly": true
}

Response Information

Response body formats

application/xml, text/xml

Sample: 
<ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ResponseCode>1</ResponseCode>
  <ResponseDescription>sample string 2</ResponseDescription>
  <MethodExpirationDate>2025-04-29T15:13:07.7810057+02:00</MethodExpirationDate>
  <ResponseObject>1</ResponseObject>
</ApiResponse>

application/json, text/json

Sample: 
{
  "ResponseCode": 1,
  "ResponseDescription": "sample string 2",
  "MethodExpirationDate": "2025-04-29T15:13:07.7810057+02:00",
  "ResponseObject": 1
}