POST api/Order

Request Information

Requires Authorization!

Add to HTTP Headers "Authorization" => "Bearer " + access_token from api/User/LoginWithApiKEY?ApiKEY={ApiKEY}
for example: "Authorization" => "Bearer aBc123-D1eF3...rS45q-XyZ879"

URI Parameters

None.

Body Parameters

PlaceOrder
NameTypeAdditional informationDescription
Customer Customer

Required

BilingCustomer Customer

None.

MailingCustomer Customer

None.

OtherCustomer Customer

None.

Bank Bank

None.

EnergyType Energy_Types

Required

CustomerType Customer_Types

Required

CustomerNumber string

Max length: 20

MeterNumber string

Required

Max length: 40

MaLoID string

None.

YearlyUsage integer

Required

AdditionalYearlyUsage integer

None.

CurrentSupplierId integer

Required

CurrentContract CurrentContract

Required

ContractStartDate date

Data type: Date

NetworkProviderId integer

None.

OrderedTariffId integer

Required

OrderedSupplierId integer

Required

SignatureDate date

Data type: DateTime

CustomerContactType CustomerContact_Types

Required

CustomerAdv CustomerAdv

Required

AdditionalInformation string

Max length: 255

OrderSource string

None.

IsIndividual boolean

None.

IsRLM boolean

None.

IsBundle boolean

None.

MeterSize string

None.

PowerKW integer

None.

IsQuery boolean

None.

GlobalMeterNumber string

Max length: 50

EnergyPricesDetails EnergyPricesDetails

None.

OrderedTariffOptions Collection of integer

None.

OtherProductOrderedTariffOptions Collection of string

None.

AsPartnerId integer

None.

StartDate date

Data type: DateTime

Request Formats

application/json, text/json

Sample:
{
  "Customer": {
    "Title": 0,
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Email": "sample string 3",
    "Birthdate": "2025-12-06T05:43:33.1358112+01:00",
    "Address": {
      "CountryCode": 0,
      "PostalCode": "sample string 1",
      "TownName": "sample string 2",
      "StreetName": "sample string 3",
      "HouseName": "sample string 4",
      "HouseName2": "sample string 5",
      "HouseEntrance": "sample string 6",
      "HouseLevel": "sample string 7",
      "HouseDoor": "sample string 8"
    },
    "PrimaryPhone": {
      "PreFix": "sample string 1",
      "Number": "sample string 2"
    },
    "AlternatePhone": {
      "PreFix": "sample string 1",
      "Number": "sample string 2"
    },
    "Fax": {
      "PreFix": "sample string 1",
      "Number": "sample string 2"
    },
    "CompanyName": "sample string 5",
    "CompanyType": 0,
    "CompanyVatNumber": "sample string 6"
  },
  "BilingCustomer": {
    "Title": 0,
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Email": "sample string 3",
    "Birthdate": "2025-12-06T05:43:33.1358112+01:00",
    "Address": {
      "CountryCode": 0,
      "PostalCode": "sample string 1",
      "TownName": "sample string 2",
      "StreetName": "sample string 3",
      "HouseName": "sample string 4",
      "HouseName2": "sample string 5",
      "HouseEntrance": "sample string 6",
      "HouseLevel": "sample string 7",
      "HouseDoor": "sample string 8"
    },
    "PrimaryPhone": {
      "PreFix": "sample string 1",
      "Number": "sample string 2"
    },
    "AlternatePhone": {
      "PreFix": "sample string 1",
      "Number": "sample string 2"
    },
    "Fax": {
      "PreFix": "sample string 1",
      "Number": "sample string 2"
    },
    "CompanyName": "sample string 5",
    "CompanyType": 0,
    "CompanyVatNumber": "sample string 6"
  },
  "MailingCustomer": {
    "Title": 0,
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Email": "sample string 3",
    "Birthdate": "2025-12-06T05:43:33.1358112+01:00",
    "Address": {
      "CountryCode": 0,
      "PostalCode": "sample string 1",
      "TownName": "sample string 2",
      "StreetName": "sample string 3",
      "HouseName": "sample string 4",
      "HouseName2": "sample string 5",
      "HouseEntrance": "sample string 6",
      "HouseLevel": "sample string 7",
      "HouseDoor": "sample string 8"
    },
    "PrimaryPhone": {
      "PreFix": "sample string 1",
      "Number": "sample string 2"
    },
    "AlternatePhone": {
      "PreFix": "sample string 1",
      "Number": "sample string 2"
    },
    "Fax": {
      "PreFix": "sample string 1",
      "Number": "sample string 2"
    },
    "CompanyName": "sample string 5",
    "CompanyType": 0,
    "CompanyVatNumber": "sample string 6"
  },
  "OtherCustomer": {
    "Title": 0,
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Email": "sample string 3",
    "Birthdate": "2025-12-06T05:43:33.1358112+01:00",
    "Address": {
      "CountryCode": 0,
      "PostalCode": "sample string 1",
      "TownName": "sample string 2",
      "StreetName": "sample string 3",
      "HouseName": "sample string 4",
      "HouseName2": "sample string 5",
      "HouseEntrance": "sample string 6",
      "HouseLevel": "sample string 7",
      "HouseDoor": "sample string 8"
    },
    "PrimaryPhone": {
      "PreFix": "sample string 1",
      "Number": "sample string 2"
    },
    "AlternatePhone": {
      "PreFix": "sample string 1",
      "Number": "sample string 2"
    },
    "Fax": {
      "PreFix": "sample string 1",
      "Number": "sample string 2"
    },
    "CompanyName": "sample string 5",
    "CompanyType": 0,
    "CompanyVatNumber": "sample string 6"
  },
  "Bank": {
    "BankFillingMode": 0,
    "IBAN": "sample string 1",
    "BIC": "sample string 2",
    "AccountHolderFirstName": "sample string 3",
    "AccountHolderLastName": "sample string 4",
    "AccountBankName": "sample string 5",
    "AccountSortCode": "sample string 6",
    "AccountNumber": "sample string 7",
    "PaymentType": 0
  },
  "EnergyType": 0,
  "CustomerType": 0,
  "CustomerNumber": "sample string 1",
  "MeterNumber": "sample string 2",
  "MaLoID": "sample string 3",
  "YearlyUsage": 4,
  "AdditionalYearlyUsage": 1,
  "CurrentSupplierId": 5,
  "CurrentContract": {
    "EndDate": "2025-12-06T05:43:33.1358112+01:00",
    "EndMode": 0
  },
  "ContractStartDate": "2025-12-06T05:43:33.1358112+01:00",
  "NetworkProviderId": 6,
  "OrderedTariffId": 7,
  "OrderedSupplierId": 8,
  "SignatureDate": "2025-12-06T05:43:33.1358112+01:00",
  "CustomerContactType": 1,
  "CustomerAdv": {
    "Email": true,
    "Phone": true,
    "Post": true
  },
  "AdditionalInformation": "sample string 10",
  "OrderSource": "sample string 11",
  "IsIndividual": true,
  "IsRLM": true,
  "IsBundle": true,
  "MeterSize": "sample string 12",
  "PowerKW": 1,
  "IsQuery": true,
  "GlobalMeterNumber": "sample string 13",
  "EnergyPricesDetails": {
    "StartDate": "2025-12-06T05:43:33.1358112+01:00",
    "EndDate": "2025-12-06T05:43:33.1358112+01:00",
    "Trade": "sample string 3",
    "TradeId": 4,
    "EnergyPricesType": 101,
    "VoltageLevel": 0,
    "PowerPeak": 5,
    "Provision": 1.0,
    "ComparativeData": {
      "ComparativeDataType": 1,
      "Price_Base": 1.0,
      "Price_HT": 2.0,
      "Price_NT": 1.0,
      "Flat_Rate": 1.0,
      "Power_Price": 1.0,
      "Current_Cost": 1.0,
      "DebugInfo": "sample string 3"
    },
    "OfferId": "ae2d3d87-eb24-4d89-bb46-b6b323f7fd71",
    "IsBundle": true,
    "Bundle_SLP_MeterCount": 1,
    "Bundle_RLM_MeterCount": 1,
    "MasterBundle_OrderId": 1
  },
  "OrderedTariffOptions": [
    1,
    2
  ],
  "OtherProductOrderedTariffOptions": [
    "sample string 1",
    "sample string 2"
  ],
  "AsPartnerId": 1,
  "StartDate": "2025-12-06T05:43:33.1358112+01:00"
}

application/xml, text/xml

Sample:
<PlaceOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Orders.Place">
  <AdditionalInformation>sample string 10</AdditionalInformation>
  <AdditionalYearlyUsage>1</AdditionalYearlyUsage>
  <AsPartnerId>1</AsPartnerId>
  <Bank xmlns:d2p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Orders">
    <d2p1:AccountBankName>sample string 5</d2p1:AccountBankName>
    <d2p1:AccountHolderFirstName>sample string 3</d2p1:AccountHolderFirstName>
    <d2p1:AccountHolderLastName>sample string 4</d2p1:AccountHolderLastName>
    <d2p1:AccountNumber>sample string 7</d2p1:AccountNumber>
    <d2p1:AccountSortCode>sample string 6</d2p1:AccountSortCode>
    <d2p1:BIC>sample string 2</d2p1:BIC>
    <d2p1:BankFillingMode>NOT_SET</d2p1:BankFillingMode>
    <d2p1:IBAN>sample string 1</d2p1:IBAN>
    <d2p1:PaymentType>MoneyTransfer</d2p1:PaymentType>
  </Bank>
  <BilingCustomer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Orders">
    <d2p1:Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:CountryCode>DE</d3p1:CountryCode>
      <d3p1:HouseDoor>sample string 8</d3p1:HouseDoor>
      <d3p1:HouseEntrance>sample string 6</d3p1:HouseEntrance>
      <d3p1:HouseLevel>sample string 7</d3p1:HouseLevel>
      <d3p1:HouseName>sample string 4</d3p1:HouseName>
      <d3p1:HouseName2>sample string 5</d3p1:HouseName2>
      <d3p1:PostalCode>sample string 1</d3p1:PostalCode>
      <d3p1:StreetName>sample string 3</d3p1:StreetName>
      <d3p1:TownName>sample string 2</d3p1:TownName>
    </d2p1:Address>
    <d2p1:AlternatePhone xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:PreFix>sample string 1</d3p1:PreFix>
    </d2p1:AlternatePhone>
    <d2p1:Birthdate>2025-12-06T05:43:33.1358112+01:00</d2p1:Birthdate>
    <d2p1:CompanyName>sample string 5</d2p1:CompanyName>
    <d2p1:CompanyType>None</d2p1:CompanyType>
    <d2p1:CompanyVatNumber>sample string 6</d2p1:CompanyVatNumber>
    <d2p1:Email>sample string 3</d2p1:Email>
    <d2p1:Fax xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:PreFix>sample string 1</d3p1:PreFix>
    </d2p1:Fax>
    <d2p1:FirstName>sample string 1</d2p1:FirstName>
    <d2p1:LastName>sample string 2</d2p1:LastName>
    <d2p1:PrimaryPhone xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:PreFix>sample string 1</d3p1:PreFix>
    </d2p1:PrimaryPhone>
    <d2p1:Title>Herr</d2p1:Title>
  </BilingCustomer>
  <ContractStartDate>2025-12-06T05:43:33.1358112+01:00</ContractStartDate>
  <CurrentContract xmlns:d2p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Orders">
    <d2p1:EndDate>2025-12-06T05:43:33.1358112+01:00</d2p1:EndDate>
    <d2p1:EndMode>NoticedByNewSupplier</d2p1:EndMode>
  </CurrentContract>
  <CurrentSupplierId>5</CurrentSupplierId>
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Orders">
    <d2p1:Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:CountryCode>DE</d3p1:CountryCode>
      <d3p1:HouseDoor>sample string 8</d3p1:HouseDoor>
      <d3p1:HouseEntrance>sample string 6</d3p1:HouseEntrance>
      <d3p1:HouseLevel>sample string 7</d3p1:HouseLevel>
      <d3p1:HouseName>sample string 4</d3p1:HouseName>
      <d3p1:HouseName2>sample string 5</d3p1:HouseName2>
      <d3p1:PostalCode>sample string 1</d3p1:PostalCode>
      <d3p1:StreetName>sample string 3</d3p1:StreetName>
      <d3p1:TownName>sample string 2</d3p1:TownName>
    </d2p1:Address>
    <d2p1:AlternatePhone xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:PreFix>sample string 1</d3p1:PreFix>
    </d2p1:AlternatePhone>
    <d2p1:Birthdate>2025-12-06T05:43:33.1358112+01:00</d2p1:Birthdate>
    <d2p1:CompanyName>sample string 5</d2p1:CompanyName>
    <d2p1:CompanyType>None</d2p1:CompanyType>
    <d2p1:CompanyVatNumber>sample string 6</d2p1:CompanyVatNumber>
    <d2p1:Email>sample string 3</d2p1:Email>
    <d2p1:Fax xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:PreFix>sample string 1</d3p1:PreFix>
    </d2p1:Fax>
    <d2p1:FirstName>sample string 1</d2p1:FirstName>
    <d2p1:LastName>sample string 2</d2p1:LastName>
    <d2p1:PrimaryPhone xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:PreFix>sample string 1</d3p1:PreFix>
    </d2p1:PrimaryPhone>
    <d2p1:Title>Herr</d2p1:Title>
  </Customer>
  <CustomerAdv xmlns:d2p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Orders">
    <d2p1:Email>true</d2p1:Email>
    <d2p1:Phone>true</d2p1:Phone>
    <d2p1:Post>true</d2p1:Post>
  </CustomerAdv>
  <CustomerContactType>Email</CustomerContactType>
  <CustomerNumber>sample string 1</CustomerNumber>
  <CustomerType>Private</CustomerType>
  <EnergyPricesDetails>
    <Bundle_RLM_MeterCount>1</Bundle_RLM_MeterCount>
    <Bundle_SLP_MeterCount>1</Bundle_SLP_MeterCount>
    <ComparativeData xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Energy">
      <d3p1:ComparativeDataType>EnergyOnly</d3p1:ComparativeDataType>
      <d3p1:Current_Cost>1</d3p1:Current_Cost>
      <d3p1:DebugInfo>sample string 3</d3p1:DebugInfo>
      <d3p1:Flat_Rate>1</d3p1:Flat_Rate>
      <d3p1:Power_Price>1</d3p1:Power_Price>
      <d3p1:Price_Base>1</d3p1:Price_Base>
      <d3p1:Price_HT>2</d3p1:Price_HT>
      <d3p1:Price_NT>1</d3p1:Price_NT>
    </ComparativeData>
    <EndDate>2025-12-06T05:43:33.1358112+01:00</EndDate>
    <EnergyPricesType>Strom_SLP_EP</EnergyPricesType>
    <IsBundle>true</IsBundle>
    <MasterBundle_OrderId>1</MasterBundle_OrderId>
    <OfferId>ae2d3d87-eb24-4d89-bb46-b6b323f7fd71</OfferId>
    <PowerPeak>5</PowerPeak>
    <Provision>1</Provision>
    <StartDate>2025-12-06T05:43:33.1358112+01:00</StartDate>
    <Trade>sample string 3</Trade>
    <TradeId>4</TradeId>
    <VoltageLevel>Not_Specified</VoltageLevel>
  </EnergyPricesDetails>
  <EnergyType>Electricity</EnergyType>
  <GlobalMeterNumber>sample string 13</GlobalMeterNumber>
  <IsBundle>true</IsBundle>
  <IsIndividual>true</IsIndividual>
  <IsQuery>true</IsQuery>
  <IsRLM>true</IsRLM>
  <MaLoID>sample string 3</MaLoID>
  <MailingCustomer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Orders">
    <d2p1:Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:CountryCode>DE</d3p1:CountryCode>
      <d3p1:HouseDoor>sample string 8</d3p1:HouseDoor>
      <d3p1:HouseEntrance>sample string 6</d3p1:HouseEntrance>
      <d3p1:HouseLevel>sample string 7</d3p1:HouseLevel>
      <d3p1:HouseName>sample string 4</d3p1:HouseName>
      <d3p1:HouseName2>sample string 5</d3p1:HouseName2>
      <d3p1:PostalCode>sample string 1</d3p1:PostalCode>
      <d3p1:StreetName>sample string 3</d3p1:StreetName>
      <d3p1:TownName>sample string 2</d3p1:TownName>
    </d2p1:Address>
    <d2p1:AlternatePhone xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:PreFix>sample string 1</d3p1:PreFix>
    </d2p1:AlternatePhone>
    <d2p1:Birthdate>2025-12-06T05:43:33.1358112+01:00</d2p1:Birthdate>
    <d2p1:CompanyName>sample string 5</d2p1:CompanyName>
    <d2p1:CompanyType>None</d2p1:CompanyType>
    <d2p1:CompanyVatNumber>sample string 6</d2p1:CompanyVatNumber>
    <d2p1:Email>sample string 3</d2p1:Email>
    <d2p1:Fax xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:PreFix>sample string 1</d3p1:PreFix>
    </d2p1:Fax>
    <d2p1:FirstName>sample string 1</d2p1:FirstName>
    <d2p1:LastName>sample string 2</d2p1:LastName>
    <d2p1:PrimaryPhone xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:PreFix>sample string 1</d3p1:PreFix>
    </d2p1:PrimaryPhone>
    <d2p1:Title>Herr</d2p1:Title>
  </MailingCustomer>
  <MeterNumber>sample string 2</MeterNumber>
  <MeterSize>sample string 12</MeterSize>
  <NetworkProviderId>6</NetworkProviderId>
  <OrderSource>sample string 11</OrderSource>
  <OrderedSupplierId>8</OrderedSupplierId>
  <OrderedTariffId>7</OrderedTariffId>
  <OrderedTariffOptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </OrderedTariffOptions>
  <OtherCustomer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Orders">
    <d2p1:Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:CountryCode>DE</d3p1:CountryCode>
      <d3p1:HouseDoor>sample string 8</d3p1:HouseDoor>
      <d3p1:HouseEntrance>sample string 6</d3p1:HouseEntrance>
      <d3p1:HouseLevel>sample string 7</d3p1:HouseLevel>
      <d3p1:HouseName>sample string 4</d3p1:HouseName>
      <d3p1:HouseName2>sample string 5</d3p1:HouseName2>
      <d3p1:PostalCode>sample string 1</d3p1:PostalCode>
      <d3p1:StreetName>sample string 3</d3p1:StreetName>
      <d3p1:TownName>sample string 2</d3p1:TownName>
    </d2p1:Address>
    <d2p1:AlternatePhone xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:PreFix>sample string 1</d3p1:PreFix>
    </d2p1:AlternatePhone>
    <d2p1:Birthdate>2025-12-06T05:43:33.1358112+01:00</d2p1:Birthdate>
    <d2p1:CompanyName>sample string 5</d2p1:CompanyName>
    <d2p1:CompanyType>None</d2p1:CompanyType>
    <d2p1:CompanyVatNumber>sample string 6</d2p1:CompanyVatNumber>
    <d2p1:Email>sample string 3</d2p1:Email>
    <d2p1:Fax xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:PreFix>sample string 1</d3p1:PreFix>
    </d2p1:Fax>
    <d2p1:FirstName>sample string 1</d2p1:FirstName>
    <d2p1:LastName>sample string 2</d2p1:LastName>
    <d2p1:PrimaryPhone xmlns:d3p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Addreses">
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:PreFix>sample string 1</d3p1:PreFix>
    </d2p1:PrimaryPhone>
    <d2p1:Title>Herr</d2p1:Title>
  </OtherCustomer>
  <OtherProductOrderedTariffOptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </OtherProductOrderedTariffOptions>
  <PowerKW>1</PowerKW>
  <SignatureDate>2025-12-06T05:43:33.1358112+01:00</SignatureDate>
  <StartDate>2025-12-06T05:43:33.1358112+01:00</StartDate>
  <YearlyUsage>4</YearlyUsage>
</PlaceOrder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameTypeAdditional informationDescription
Version Version

None.

Content HttpContent

None.

StatusCode HttpStatusCode

None.

ReasonPhrase string

None.

Headers Collection of Object

None.

RequestMessage HttpRequestMessage

None.

IsSuccessStatusCode boolean

None.