Mercedes.Agency.Orchestration.API

<back to all web services

CreateBackOrderRequest

BackOrder
Requires Authentication
The following routes are available for this service:
POST/v1/backorderCreate Back Order (Online Showroom)
namespace Mercedes.Agency.API.Shared.Enums

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CreateBackOrderResponse() = 
        member val Guid:String = null with get,set
        member val Reference:String = null with get,set

    type Source =
        | OnlineShowroom = 1
        | OneAdmin = 2

    [<AllowNullLiteral>]
    type Address() = 
        member val Property:String = null with get,set
        member val Street:String = null with get,set
        member val Town:String = null with get,set
        member val County:String = null with get,set
        member val Locality:String = null with get,set
        member val Postcode:String = null with get,set

    type CustomerMode =
        | Private = 1
        | Business = 2
        | Motability = 3

    [<AllowNullLiteral>]
    type SalesforceCustomer() = 
        member val CustomerId:String = null with get,set
        member val IsCiam:Boolean = new Boolean() with get,set
        member val CompanyName:String = null with get,set
        member val Title:String = null with get,set
        member val Firstname:String = null with get,set
        member val Surname:String = null with get,set
        member val EmailAddress:String = null with get,set
        member val Telephone:String = null with get,set
        member val Address:Address = null with get,set
        member val Mode:CustomerMode = new CustomerMode() with get,set

    [<AllowNullLiteral>]
    type Preferences() = 
        member val OptinEmail:Boolean = new Boolean() with get,set
        member val OptinPost:Boolean = new Boolean() with get,set
        member val OptinSMS:Boolean = new Boolean() with get,set
        member val OptinTelephone:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type Customer() = 
        inherit SalesforceCustomer()
        member val ProfileId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Preferences:Preferences = null with get,set

    [<AllowNullLiteral>]
    type JsonVersion() = 
        member val Version:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CriteriaModel() = 
        member val Description:String = null with get,set
        member val Id:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CriteriaDifference() = 
        member val Model:Boolean = new Boolean() with get,set
        member val Transmission:Boolean = new Boolean() with get,set
        member val Fuel:Boolean = new Boolean() with get,set
        member val Upholstery:Boolean = new Boolean() with get,set
        member val Equipment:Boolean = new Boolean() with get,set
        member val Line:Boolean = new Boolean() with get,set
        member val BodyStyle:Boolean = new Boolean() with get,set
        member val ColourGroup:Boolean = new Boolean() with get,set
        member val Packages:Boolean = new Boolean() with get,set
        member val Engine:Boolean = new Boolean() with get,set
        member val AdditionalInformation:Boolean = new Boolean() with get,set
        member val UrlReferrer:Boolean = new Boolean() with get,set
        member val PreferredDeliveryDate:Boolean = new Boolean() with get,set
        member val IsSmart:Boolean = new Boolean() with get,set
        member val IsSpecialised:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CriteriaBase() = 
        inherit JsonVersion()
        member val Transmission:String[] = null with get,set
        member val Fuel:String[] = null with get,set
        member val Upholstery:String[] = null with get,set
        member val Equipment:String[] = null with get,set
        member val Line:String[] = null with get,set
        member val BodyStyle:String[] = null with get,set
        member val ColourGroup:String[] = null with get,set
        member val Packages:String[] = null with get,set
        member val Model:ResizeArray<CriteriaModel> = null with get,set
        member val UrlReferrer:String = null with get,set
        member val PreferredDeliveryDate:String = null with get,set
        [<ApiMember(ExcludeInSchema=true)>]
        member val IsNewModel:Boolean = new Boolean() with get,set

        [<ApiMember(ExcludeInSchema=true)>]
        member val IsSmart:Boolean = new Boolean() with get,set

        [<ApiMember(ExcludeInSchema=true)>]
        member val IsSpecialised:Boolean = new Boolean() with get,set

        [<ApiMember(ExcludeInSchema=true)>]
        member val CriteriaDifference:CriteriaDifference = null with get,set

    [<AllowNullLiteral>]
    type Criteria() = 
        inherit CriteriaBase()
        member val Engine:String[] = null with get,set

    [<AllowNullLiteral>]
    type V2EngineCriteria() = 
        member val Badge:String = null with get,set
        member val Brand:String = null with get,set

    [<AllowNullLiteral>]
    type V2Criteria() = 
        inherit CriteriaBase()
        member val Engine:ResizeArray<V2EngineCriteria> = null with get,set

    [<AllowNullLiteral>]
    type OutrightPurchase() = 
        member val IsOutrightPurchase:Boolean = new Boolean() with get,set
        member val Reference:String = null with get,set
        member val DiscountRate:Decimal = new Decimal() with get,set
        member val Bm7NST:String = null with get,set
        member val IsBackOrder:Boolean = new Boolean() with get,set
        member val IsCOPConverter:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CreateBackOrderBase() = 
        member val GssnId:String = null with get,set
        member val AdditionalInformation:String = null with get,set
        member val ConfigCode:String = null with get,set
        member val Source:Source = new Source() with get,set
        member val TagUrl:String = null with get,set
        member val Customer:Customer = null with get,set
        member val CustomerCriteria:Criteria = null with get,set
        member val AgentCriteria:V2Criteria = null with get,set
        member val OutrightPurchase:OutrightPurchase = null with get,set
        member val GasId:String = null with get,set
        member val Motability:Boolean = new Boolean() with get,set
        member val MotabilityPricingId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AssistanceProviderId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AssistanceDetail:String = null with get,set
        member val ConfiguratorCode:String = null with get,set

    [<AllowNullLiteral>]
    type CreateBackOrderRequest() = 
        inherit CreateBackOrderBase()
        interface IPost

F# CreateBackOrderRequest DTOs

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 /v1/backorder HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateBackOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders">
  <AdditionalInformation xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">String</AdditionalInformation>
  <AgentCriteria xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">
    <d2p1:Version>0</d2p1:Version>
    <d2p1:BodyStyle xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:BodyStyle>
    <d2p1:ColourGroup xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:ColourGroup>
    <d2p1:CriteriaDifference>
      <d2p1:AdditionalInformation>false</d2p1:AdditionalInformation>
      <d2p1:BodyStyle>false</d2p1:BodyStyle>
      <d2p1:ColourGroup>false</d2p1:ColourGroup>
      <d2p1:Engine>false</d2p1:Engine>
      <d2p1:Equipment>false</d2p1:Equipment>
      <d2p1:Fuel>false</d2p1:Fuel>
      <d2p1:IsSmart>false</d2p1:IsSmart>
      <d2p1:IsSpecialised>false</d2p1:IsSpecialised>
      <d2p1:Line>false</d2p1:Line>
      <d2p1:Model>false</d2p1:Model>
      <d2p1:Packages>false</d2p1:Packages>
      <d2p1:PreferredDeliveryDate>false</d2p1:PreferredDeliveryDate>
      <d2p1:Transmission>false</d2p1:Transmission>
      <d2p1:Upholstery>false</d2p1:Upholstery>
      <d2p1:UrlReferrer>false</d2p1:UrlReferrer>
    </d2p1:CriteriaDifference>
    <d2p1:Equipment xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Equipment>
    <d2p1:Fuel xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Fuel>
    <d2p1:IsNewModel>false</d2p1:IsNewModel>
    <d2p1:IsSmart>false</d2p1:IsSmart>
    <d2p1:IsSpecialised>false</d2p1:IsSpecialised>
    <d2p1:Line xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Line>
    <d2p1:Model>
      <d2p1:CriteriaModel>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Id>0</d2p1:Id>
      </d2p1:CriteriaModel>
    </d2p1:Model>
    <d2p1:Packages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Packages>
    <d2p1:PreferredDeliveryDate>String</d2p1:PreferredDeliveryDate>
    <d2p1:Transmission xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Transmission>
    <d2p1:Upholstery xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Upholstery>
    <d2p1:UrlReferrer>String</d2p1:UrlReferrer>
    <d2p1:Engine>
      <d2p1:V2EngineCriteria>
        <d2p1:Badge>String</d2p1:Badge>
        <d2p1:Brand>String</d2p1:Brand>
      </d2p1:V2EngineCriteria>
    </d2p1:Engine>
  </AgentCriteria>
  <AssistanceDetail xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">String</AssistanceDetail>
  <AssistanceProviderId xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">0</AssistanceProviderId>
  <ConfigCode xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">String</ConfigCode>
  <ConfiguratorCode xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">String</ConfiguratorCode>
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">
    <d2p1:Address>
      <d2p1:County>String</d2p1:County>
      <d2p1:Locality>String</d2p1:Locality>
      <d2p1:Postcode>String</d2p1:Postcode>
      <d2p1:Property>String</d2p1:Property>
      <d2p1:Street>String</d2p1:Street>
      <d2p1:Town>String</d2p1:Town>
    </d2p1:Address>
    <d2p1:CompanyName>String</d2p1:CompanyName>
    <d2p1:CustomerId>String</d2p1:CustomerId>
    <d2p1:EmailAddress>String</d2p1:EmailAddress>
    <d2p1:Firstname>String</d2p1:Firstname>
    <d2p1:IsCiam>false</d2p1:IsCiam>
    <d2p1:Mode>Private</d2p1:Mode>
    <d2p1:Surname>String</d2p1:Surname>
    <d2p1:Telephone>String</d2p1:Telephone>
    <d2p1:Title>String</d2p1:Title>
    <d2p1:Preferences>
      <d2p1:OptinEmail>false</d2p1:OptinEmail>
      <d2p1:OptinPost>false</d2p1:OptinPost>
      <d2p1:OptinSMS>false</d2p1:OptinSMS>
      <d2p1:OptinTelephone>false</d2p1:OptinTelephone>
    </d2p1:Preferences>
    <d2p1:ProfileId>00000000-0000-0000-0000-000000000000</d2p1:ProfileId>
  </Customer>
  <CustomerCriteria xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">
    <d2p1:Version>0</d2p1:Version>
    <d2p1:BodyStyle xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:BodyStyle>
    <d2p1:ColourGroup xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:ColourGroup>
    <d2p1:CriteriaDifference>
      <d2p1:AdditionalInformation>false</d2p1:AdditionalInformation>
      <d2p1:BodyStyle>false</d2p1:BodyStyle>
      <d2p1:ColourGroup>false</d2p1:ColourGroup>
      <d2p1:Engine>false</d2p1:Engine>
      <d2p1:Equipment>false</d2p1:Equipment>
      <d2p1:Fuel>false</d2p1:Fuel>
      <d2p1:IsSmart>false</d2p1:IsSmart>
      <d2p1:IsSpecialised>false</d2p1:IsSpecialised>
      <d2p1:Line>false</d2p1:Line>
      <d2p1:Model>false</d2p1:Model>
      <d2p1:Packages>false</d2p1:Packages>
      <d2p1:PreferredDeliveryDate>false</d2p1:PreferredDeliveryDate>
      <d2p1:Transmission>false</d2p1:Transmission>
      <d2p1:Upholstery>false</d2p1:Upholstery>
      <d2p1:UrlReferrer>false</d2p1:UrlReferrer>
    </d2p1:CriteriaDifference>
    <d2p1:Equipment xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Equipment>
    <d2p1:Fuel xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Fuel>
    <d2p1:IsNewModel>false</d2p1:IsNewModel>
    <d2p1:IsSmart>false</d2p1:IsSmart>
    <d2p1:IsSpecialised>false</d2p1:IsSpecialised>
    <d2p1:Line xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Line>
    <d2p1:Model>
      <d2p1:CriteriaModel>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Id>0</d2p1:Id>
      </d2p1:CriteriaModel>
    </d2p1:Model>
    <d2p1:Packages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Packages>
    <d2p1:PreferredDeliveryDate>String</d2p1:PreferredDeliveryDate>
    <d2p1:Transmission xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Transmission>
    <d2p1:Upholstery xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Upholstery>
    <d2p1:UrlReferrer>String</d2p1:UrlReferrer>
    <d2p1:Engine xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Engine>
  </CustomerCriteria>
  <GasId xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">String</GasId>
  <GssnId xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">String</GssnId>
  <Motability xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">false</Motability>
  <MotabilityPricingId xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">0</MotabilityPricingId>
  <OutrightPurchase xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">
    <d2p1:Bm7NST>String</d2p1:Bm7NST>
    <d2p1:DiscountRate>0</d2p1:DiscountRate>
    <d2p1:IsBackOrder>false</d2p1:IsBackOrder>
    <d2p1:IsCOPConverter>false</d2p1:IsCOPConverter>
    <d2p1:IsOutrightPurchase>false</d2p1:IsOutrightPurchase>
    <d2p1:Reference>String</d2p1:Reference>
  </OutrightPurchase>
  <Source xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">OnlineShowroom</Source>
  <TagUrl xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">String</TagUrl>
</CreateBackOrderRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateBackOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Responses">
  <Guid>String</Guid>
  <Reference>String</Reference>
</CreateBackOrderResponse>