<back to all web services
ConfirmOrder
Confirm an Order
Requires Authentication
Required permission: | all |
The following routes are available for this service:POST | /orders/{OrderId}/confirm | | |
---|
ConfirmOrder Parameters:Name | Parameter | Data Type | Required | Description |
---|
OrderId | path | int | Yes | The id of the order to confirm. |
CustomerId | body | string | No | |
CustomerSalutation | body | string | No | |
CustomerFirstName | body | string | Yes | |
CustomerLastName | body | string | Yes | |
CustomerPostalCode | body | string | Yes | |
CustomerCity | body | string | Yes | |
CustomerCountry | body | string | Yes | |
CustomerStreet | body | string | Yes | |
CustomerStreetNumber | body | string | No | |
CustomerCompany | body | string | No | |
CustomerCompany2 | body | string | No | |
AdditionToAddress | body | string | No | |
DeliveryAddressSalutation | body | string | No | |
DeliveryAddressFirstName | body | string | No | |
DeliveryAddressLastName | body | string | No | |
DeliveryAddressPostalCode | body | string | No | |
DeliveryAddressCity | body | string | No | |
DeliveryAddressCountry | body | string | No | |
DeliveryAddressStreet | body | string | No | |
DeliveryAddressStreetNumber | body | string | No | |
DeliveryAddressCompany | body | string | No | |
AdditionToDeliveryAddress | body | string | No | |
CustomerIban | body | string | No | |
CustomerBic | body | string | No | |
CustomerSepaMandateReference | body | string | No | |
CustomerSepaMandateDate | body | DateTime? | No | |
AccountHolderName | body | string | No | |
CustomerEMail | body | string | Yes | |
Note | body | string | No | |
PaymentMethod | body | string | No | |
ShippingMethod | body | string | No | |
ExternalCustomerId | body | string | No | |
DeliveryDate | body | DateTime? | No | |
OrderNumber | body | string | No | |
Payment | body | OrderPayment | No | |
MediaCode | body | string | No | |
OrderPayment Parameters:Name | Parameter | Data Type | Required | Description |
---|
Amount | form | decimal | Yes | |
Name | form | string | Yes | |
Date | form | DateTime | No | |
ReferenceNumber | form | string | No | The reference number for the payment. |
FinancialAccountNumber | form | string | No | |
Type | form | string | No | The type of payment. Supported values: PayPal, Unknown or an empty string. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /orders/{OrderId}/confirm HTTP/1.1
Host: bestellforum.api.mauve.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ConfirmOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mauve.Bestellforum.ServiceModel">
<AccountHolderName>String</AccountHolderName>
<AdditionToAddress>String</AdditionToAddress>
<AdditionToDeliveryAddress>String</AdditionToDeliveryAddress>
<CustomerBic>String</CustomerBic>
<CustomerCity>String</CustomerCity>
<CustomerCompany>String</CustomerCompany>
<CustomerCompany2>String</CustomerCompany2>
<CustomerCountry>String</CustomerCountry>
<CustomerEMail>String</CustomerEMail>
<CustomerFirstName>String</CustomerFirstName>
<CustomerIban>String</CustomerIban>
<CustomerId>String</CustomerId>
<CustomerLastName>String</CustomerLastName>
<CustomerPostalCode>String</CustomerPostalCode>
<CustomerSalutation>String</CustomerSalutation>
<CustomerSepaMandateDate>0001-01-01T00:00:00</CustomerSepaMandateDate>
<CustomerSepaMandateReference>String</CustomerSepaMandateReference>
<CustomerStreet>String</CustomerStreet>
<CustomerStreetNumber>String</CustomerStreetNumber>
<DeliveryAddressCity>String</DeliveryAddressCity>
<DeliveryAddressCompany>String</DeliveryAddressCompany>
<DeliveryAddressCountry>String</DeliveryAddressCountry>
<DeliveryAddressFirstName>String</DeliveryAddressFirstName>
<DeliveryAddressLastName>String</DeliveryAddressLastName>
<DeliveryAddressPostalCode>String</DeliveryAddressPostalCode>
<DeliveryAddressSalutation>String</DeliveryAddressSalutation>
<DeliveryAddressStreet>String</DeliveryAddressStreet>
<DeliveryAddressStreetNumber>String</DeliveryAddressStreetNumber>
<DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
<ExternalCustomerId>String</ExternalCustomerId>
<MediaCode>String</MediaCode>
<Note>String</Note>
<OrderId>0</OrderId>
<OrderNumber>String</OrderNumber>
<Payment xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mauve.Bestellforum.ServiceModel.Types">
<d2p1:Amount>0</d2p1:Amount>
<d2p1:Date>0001-01-01T00:00:00</d2p1:Date>
<d2p1:FinancialAccountNumber>String</d2p1:FinancialAccountNumber>
<d2p1:Name>String</d2p1:Name>
<d2p1:ReferenceNumber>String</d2p1:ReferenceNumber>
<d2p1:Type>String</d2p1:Type>
</Payment>
<PaymentMethod>String</PaymentMethod>
<ShippingMethod>String</ShippingMethod>
</ConfirmOrder>