Mercedes.Agency.Orchestration.API

<back to all web services

UpdateInflightOrderVoucherRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/order/inflight/voucherUpdate inflight order voucher codeUpdates an existing active order with a new voucher code offer
UpdateInflightOrderVoucherRequest Parameters:
NameParameterData TypeRequiredDescription
OrderIdbodyintNo
VoucherOfferItemIdbodyintNo
VoucherCodebodystringYes
VINbodystringYes
OrderReferencebodystringYes
CommissionNumberbodystringNo
UpdateInflightOrderVoucherResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo

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.

PUT /v1/order/inflight/voucher HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateInflightOrderVoucherRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Orders">
  <CommissionNumber>String</CommissionNumber>
  <OrderId>0</OrderId>
  <OrderReference>String</OrderReference>
  <VIN>String</VIN>
  <VoucherCode>String</VoucherCode>
  <VoucherOfferItemId>0</VoucherOfferItemId>
</UpdateInflightOrderVoucherRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateInflightOrderVoucherResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Orders">
  <Success>false</Success>
</UpdateInflightOrderVoucherResponse>