PUT api/Orders
Updates an order
Request Information
URI Parameters
None.
Body Parameters
PutOrderRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId | integer |
None. |
|
| Note | string |
Max length: 4000 |
|
| CustomerNumber | integer |
None. |
|
| DeliveryAddress | DeliveryAddress |
None. |
|
| TimebookReservationId | globally unique identifier |
None. |
|
| CalendarEventId | integer |
None. |
|
| PaymentTransactionProviderId | string |
Max length: 56 |
|
| AgreementNo | integer |
None. |
|
| RetailPriceListId | globally unique identifier |
None. |
|
| SplitId | globally unique identifier |
None. |
|
| OrderLines | Collection of OrderLineRequest |
Required |
|
| OrderType | OrderType |
None. |
|
| SellerBranchId | integer |
Required |
|
| OrderDate | date |
Required |
|
| LicensePlate | string |
Max length: 15 |
|
| Odometer | integer |
None. |
|
| WorkOrderNumber | string |
Max length: 40 |
|
| SalesPerson | string |
Required Max length: 50 |
|
| CurrencyId | integer |
Required |
|
| CurrencyRate | decimal number |
Required |
|
| DeliveryDate | date |
None. |
|
| RequisitionOrderNumber | string |
Max length: 40 |
|
| TotalAmountIncludingVat | decimal number |
None. |
|
| TotalAmountExcludingVat | decimal number |
None. |
|
| RoundingAmount | decimal number |
None. |
|
| CustomerReference | string |
Max length: 40 |
|
| ContactId | globally unique identifier |
None. |
Remarks
None.
Example
//
//
//
Request Formats
application/json, text/json
Sample:
{
"OrderId": 1,
"Note": "sample string 2",
"CustomerNumber": 1,
"DeliveryAddress": {
"Name": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"PostalCode": "sample string 5",
"Town": "sample string 6",
"Country": "sample string 7",
"CountryCode": "sample string 8"
},
"TimebookReservationId": "c7c00c0a-1410-4073-9e2b-d9a26cc28e5a",
"CalendarEventId": 1,
"PaymentTransactionProviderId": "sample string 3",
"AgreementNo": 1,
"RetailPriceListId": "42c5b558-6fd3-4dcc-b82f-64db7b99aad4",
"SplitId": "f12ec68c-8588-42c0-9156-878a1f7e357c",
"OrderLines": [
{
"OrderLineArticle": {
"SalesAccount": 1,
"StockNumber": 1,
"CostPrice": 2.0,
"IsExportWithinEU": true,
"OrderType": 0,
"ArticleNumber": 4,
"Quantity": 5.0,
"Description": "sample string 6",
"Price": 7.0,
"DiscountFactor": 8.0,
"Amount": 9.0,
"VatPercent": 10.0,
"VatAmount": 11.0,
"HasVat": true,
"IsExport": true
},
"OrderLineText": {
"Text": "sample string 1"
},
"LineNumber": 1,
"ParentLineNumber": 1,
"IsArticlePackageLine": true,
"HasFixedQuantity": true
},
{
"OrderLineArticle": {
"SalesAccount": 1,
"StockNumber": 1,
"CostPrice": 2.0,
"IsExportWithinEU": true,
"OrderType": 0,
"ArticleNumber": 4,
"Quantity": 5.0,
"Description": "sample string 6",
"Price": 7.0,
"DiscountFactor": 8.0,
"Amount": 9.0,
"VatPercent": 10.0,
"VatAmount": 11.0,
"HasVat": true,
"IsExport": true
},
"OrderLineText": {
"Text": "sample string 1"
},
"LineNumber": 1,
"ParentLineNumber": 1,
"IsArticlePackageLine": true,
"HasFixedQuantity": true
}
],
"OrderType": 1,
"SellerBranchId": 4,
"OrderDate": "2026-01-21 22:50:34",
"LicensePlate": "sample string 6",
"Odometer": 1,
"WorkOrderNumber": "sample string 7",
"SalesPerson": "sample string 8",
"CurrencyId": 9,
"CurrencyRate": 10.0,
"DeliveryDate": "2026-01-21 22:50:34",
"RequisitionOrderNumber": "sample string 11",
"TotalAmountIncludingVat": 1.0,
"TotalAmountExcludingVat": 1.0,
"RoundingAmount": 1.0,
"CustomerReference": "sample string 12",
"ContactId": "491ed592-5dac-4bdf-8155-85653b7fdcc7"
}
application/xml, text/xml
Sample:
<PutOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Order">
<ContactId>491ed592-5dac-4bdf-8155-85653b7fdcc7</ContactId>
<CurrencyId>9</CurrencyId>
<CurrencyRate>10</CurrencyRate>
<CustomerNumber>1</CustomerNumber>
<CustomerReference>sample string 12</CustomerReference>
<DeliveryDate>2026-01-21T22:50:34.5233909+01:00</DeliveryDate>
<LicensePlate>sample string 6</LicensePlate>
<Odometer>1</Odometer>
<OrderDate>2026-01-21T22:50:34.5233909+01:00</OrderDate>
<OrderType>NormalOrder</OrderType>
<RequisitionOrderNumber>sample string 11</RequisitionOrderNumber>
<RoundingAmount>1</RoundingAmount>
<SalesPerson>sample string 8</SalesPerson>
<SellerBranchId>4</SellerBranchId>
<TotalAmountExcludingVat>1</TotalAmountExcludingVat>
<TotalAmountIncludingVat>1</TotalAmountIncludingVat>
<WorkOrderNumber>sample string 7</WorkOrderNumber>
<AgreementNo>1</AgreementNo>
<CalendarEventId>1</CalendarEventId>
<DeliveryAddress>
<Address1>sample string 2</Address1>
<Address2>sample string 3</Address2>
<Address3>sample string 4</Address3>
<Country>sample string 7</Country>
<CountryCode>sample string 8</CountryCode>
<Name>sample string 1</Name>
<PostalCode>sample string 5</PostalCode>
<Town>sample string 6</Town>
</DeliveryAddress>
<Note>sample string 2</Note>
<OrderLines>
<OrderLineRequest>
<HasFixedQuantity>true</HasFixedQuantity>
<IsArticlePackageLine>true</IsArticlePackageLine>
<LineNumber>1</LineNumber>
<ParentLineNumber>1</ParentLineNumber>
<OrderLineArticle>
<Amount>9</Amount>
<ArticleNumber>4</ArticleNumber>
<Description>sample string 6</Description>
<DiscountFactor>8</DiscountFactor>
<HasVat>true</HasVat>
<IsExport>true</IsExport>
<Price>7</Price>
<Quantity>5</Quantity>
<VatAmount>11</VatAmount>
<VatPercent>10</VatPercent>
<CostPrice>2</CostPrice>
<IsExportWithinEU>true</IsExportWithinEU>
<OrderType>UnAffected</OrderType>
<SalesAccount>1</SalesAccount>
<StockNumber>1</StockNumber>
</OrderLineArticle>
<OrderLineText>
<Text>sample string 1</Text>
</OrderLineText>
</OrderLineRequest>
<OrderLineRequest>
<HasFixedQuantity>true</HasFixedQuantity>
<IsArticlePackageLine>true</IsArticlePackageLine>
<LineNumber>1</LineNumber>
<ParentLineNumber>1</ParentLineNumber>
<OrderLineArticle>
<Amount>9</Amount>
<ArticleNumber>4</ArticleNumber>
<Description>sample string 6</Description>
<DiscountFactor>8</DiscountFactor>
<HasVat>true</HasVat>
<IsExport>true</IsExport>
<Price>7</Price>
<Quantity>5</Quantity>
<VatAmount>11</VatAmount>
<VatPercent>10</VatPercent>
<CostPrice>2</CostPrice>
<IsExportWithinEU>true</IsExportWithinEU>
<OrderType>UnAffected</OrderType>
<SalesAccount>1</SalesAccount>
<StockNumber>1</StockNumber>
</OrderLineArticle>
<OrderLineText>
<Text>sample string 1</Text>
</OrderLineText>
</OrderLineRequest>
</OrderLines>
<PaymentTransactionProviderId>sample string 3</PaymentTransactionProviderId>
<RetailPriceListId>42c5b558-6fd3-4dcc-b82f-64db7b99aad4</RetailPriceListId>
<SplitId>f12ec68c-8588-42c0-9156-878a1f7e357c</SplitId>
<TimebookReservationId>c7c00c0a-1410-4073-9e2b-d9a26cc28e5a</TimebookReservationId>
<OrderId>1</OrderId>
</PutOrderRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PutOrderResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Errors | Collection of PutOrderError |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Errors": [
{
"ErrorCode": 1,
"ErrorMessage": "sample string 1"
},
{
"ErrorCode": 1,
"ErrorMessage": "sample string 1"
}
]
}
application/xml, text/xml
Sample:
<PutOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Order">
<Errors>
<PutOrderError>
<ErrorCode>OrderNotFound</ErrorCode>
<ErrorMessage>sample string 1</ErrorMessage>
</PutOrderError>
<PutOrderError>
<ErrorCode>OrderNotFound</ErrorCode>
<ErrorMessage>sample string 1</ErrorMessage>
</PutOrderError>
</Errors>
<Success>true</Success>
</PutOrderResponse>
