POST api/ThirdPartyOrders

Add an order.

Request Information

URI Parameters

None.

Body Parameters

ThirdPartyOrderHeadRequest
NameDescriptionTypeAdditional information
Note

A note for the order

 string

Max length: 4000
CustomerNumber

The customer number is a must for third party orders

 integer

Required
DeliveryAddress

The address to which the goods are delivered

 DeliveryAddress

None.
OrderLines

An order must have at least one order line.

 Collection of OrderLineRequest

Required
OrderType

This construct is made in order to introduce order type without breaking the exposed interface

 OrderType

None.
SellerBranchId

Branch id of the branch owning the order.

 integer

Required
OrderDate

Date when ther order is placed.

 date

Required
LicensePlate

License plate number.

 string

Max length: 15
Odometer

Odometer.

 integer

None.
WorkOrderNumber

string

Max length: 40
SalesPerson

Name of the person responsible for the order.

 string

Required

Max length: 50
CurrencyId

Currecy id. A list of suppoerted currencies can be fetched through the API with /api/currencies

 integer

Required
CurrencyRate

Actual currency rate used on order.

 decimal number

Required
DeliveryDate

Requested delivery date for the order.

 date

None.
RequisitionOrderNumber

string

Max length: 40
TotalAmountIncludingVat

Total order amount including discount and VAT.

 decimal number

None.
TotalAmountExcludingVat

Total order amount including discount but without VAT.

 decimal number

None.
RoundingAmount

Optional rounding amount.

 decimal number

None.
CustomerReference

Customers order reference.

 string

Max length: 40
ContactId

Customer contact id. Use api/contacts/{id} to get contact details.

 globally unique identifier

None.

Remarks

None.

Example

//Posts an order to
http://localhost/api/orders/

Request Formats

application/json, text/json

Sample: 
{
  "Note": "sample string 1",
  "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"
  },
  "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": 2,
  "OrderDate": "12/21/2025 1:04:08 PM",
  "LicensePlate": "sample string 4",
  "Odometer": 1,
  "WorkOrderNumber": "sample string 5",
  "SalesPerson": "sample string 6",
  "CurrencyId": 7,
  "CurrencyRate": 8.0,
  "DeliveryDate": "12/21/2025 1:04:08 PM",
  "RequisitionOrderNumber": "sample string 9",
  "TotalAmountIncludingVat": 1.0,
  "TotalAmountExcludingVat": 1.0,
  "RoundingAmount": 1.0,
  "CustomerReference": "sample string 10",
  "ContactId": "965fe030-7a94-4d8b-8f29-4f9198a91087"
}

application/xml, text/xml

Sample: 
<ThirdPartyOrderHeadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Order">
  <ContactId>965fe030-7a94-4d8b-8f29-4f9198a91087</ContactId>
  <CurrencyId>7</CurrencyId>
  <CurrencyRate>8</CurrencyRate>
  <CustomerNumber>1</CustomerNumber>
  <CustomerReference>sample string 10</CustomerReference>
  <DeliveryDate>2025-12-21T13:04:08.6937165+00:00</DeliveryDate>
  <LicensePlate>sample string 4</LicensePlate>
  <Odometer>1</Odometer>
  <OrderDate>2025-12-21T13:04:08.6937165+00:00</OrderDate>
  <OrderType>NormalOrder</OrderType>
  <RequisitionOrderNumber>sample string 9</RequisitionOrderNumber>
  <RoundingAmount>1</RoundingAmount>
  <SalesPerson>sample string 6</SalesPerson>
  <SellerBranchId>2</SellerBranchId>
  <TotalAmountExcludingVat>1</TotalAmountExcludingVat>
  <TotalAmountIncludingVat>1</TotalAmountIncludingVat>
  <WorkOrderNumber>sample string 5</WorkOrderNumber>
  <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 1</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>
</ThirdPartyOrderHeadRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ThirdPartyOrderHeadRequest'.

Response Information

Resource Description

OrderId

integer

Response Formats

application/json, text/json

Sample: 
1

application/xml, text/xml

Sample: 
<long xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</long>