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)Create Back Order (Online Showroom)
CreateBackOrderBase Parameters:
NameParameterData TypeRequiredDescription
GssnIdformstringYes
AdditionalInformationformstringYes
ConfigCodeformstringYes
SourceformSourceNo
TagUrlformstringYes
CustomerformCustomerYes
CustomerCriteriaformCriteriaYes
AgentCriteriaformV2CriteriaYes
OutrightPurchaseformOutrightPurchaseNo
GasIdformstringYes
MotabilityformboolNo
MotabilityPricingIdformint?No
AssistanceProviderIdformint?No
AssistanceDetailformstringNo
ConfiguratorCodeformstringNo
Source Enum:
NameValue
OnlineShowroom1
OneAdmin2
Customer Parameters:
NameParameterData TypeRequiredDescription
ProfileIdformGuid?No
PreferencesformPreferencesNo
SalesforceCustomer Parameters:
NameParameterData TypeRequiredDescription
CustomerIdformstringYes
IsCiamformboolNo
CompanyNameformstringYes
TitleformstringYes
FirstnameformstringYes
SurnameformstringYes
EmailAddressformstringYes
TelephoneformstringYes
AddressformAddressYes
ModeformCustomerModeNo
Address Parameters:
NameParameterData TypeRequiredDescription
PropertyformstringYes
StreetformstringYes
TownformstringYes
CountyformstringYes
LocalityformstringYes
PostcodeformstringYes
CustomerMode Enum:
NameValue
Private1
Business2
Motability3
Preferences Parameters:
NameParameterData TypeRequiredDescription
OptinEmailformboolNo
OptinPostformboolNo
OptinSMSformboolNo
OptinTelephoneformboolNo
Criteria Parameters:
NameParameterData TypeRequiredDescription
Engineformstring[]Yes
CriteriaBase Parameters:
NameParameterData TypeRequiredDescription
Transmissionformstring[]Yes
Fuelformstring[]Yes
Upholsteryformstring[]Yes
Equipmentformstring[]Yes
Lineformstring[]Yes
BodyStyleformstring[]Yes
ColourGroupformstring[]Yes
Packagesformstring[]Yes
ModelformList<CriteriaModel>Yes
UrlReferrerformstringYes
PreferredDeliveryDateformstringYes
IsNewModelformboolNo
IsSmartformboolNo
IsSpecialisedformboolNo
CriteriaDifferenceformCriteriaDifferenceYes
JsonVersion Parameters:
NameParameterData TypeRequiredDescription
VersionformintNo
CriteriaModel Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYes
IdformintNo
CriteriaDifference Parameters:
NameParameterData TypeRequiredDescription
ModelformboolNo
TransmissionformboolNo
FuelformboolNo
UpholsteryformboolNo
EquipmentformboolNo
LineformboolNo
BodyStyleformboolNo
ColourGroupformboolNo
PackagesformboolNo
EngineformboolNo
AdditionalInformationformboolNo
UrlReferrerformboolNo
PreferredDeliveryDateformboolNo
IsSmartformboolNo
IsSpecialisedformboolNo
V2Criteria Parameters:
NameParameterData TypeRequiredDescription
EngineformList<V2EngineCriteria>Yes
V2EngineCriteria Parameters:
NameParameterData TypeRequiredDescription
BadgeformstringYes
BrandformstringYes
OutrightPurchase Parameters:
NameParameterData TypeRequiredDescription
IsOutrightPurchaseformboolNo
ReferenceformstringYes
DiscountRateformdecimalNo
Bm7NSTformstringYes
IsBackOrderformboolNo
IsCOPConverterformboolNo
CreateBackOrderResponse Parameters:
NameParameterData TypeRequiredDescription
GuidformstringYes
ReferenceformstringYes
ConsentAgreedStatusformConsentAgreedStatusNo
MessageDeliveredformbool?No
ConsentAgreedStatus Parameters:
NameParameterData TypeRequiredDescription
ConsentStatusformstringYes
ConsentSelectedformDictionary<string, bool>Yes
RecommendedActionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"GssnId":"String","AdditionalInformation":"String","ConfigCode":"String","Source":"OnlineShowroom","TagUrl":"String","Customer":{"ProfileId":"00000000000000000000000000000000","Preferences":{"OptinEmail":false,"OptinPost":false,"OptinSMS":false,"OptinTelephone":false},"CustomerId":"String","IsCiam":false,"CompanyName":"String","Title":"String","Firstname":"String","Surname":"String","EmailAddress":"String","Telephone":"String","Address":{"Property":"String","Street":"String","Town":"String","County":"String","Locality":"String","Postcode":"String"},"Mode":"Private"},"CustomerCriteria":{"Engine":["String"],"Transmission":["String"],"Fuel":["String"],"Upholstery":["String"],"Equipment":["String"],"Line":["String"],"BodyStyle":["String"],"ColourGroup":["String"],"Packages":["String"],"Model":[{"Description":"String","Id":0}],"UrlReferrer":"String","PreferredDeliveryDate":"String","IsNewModel":false,"IsSmart":false,"IsSpecialised":false,"CriteriaDifference":{"Model":false,"Transmission":false,"Fuel":false,"Upholstery":false,"Equipment":false,"Line":false,"BodyStyle":false,"ColourGroup":false,"Packages":false,"Engine":false,"AdditionalInformation":false,"UrlReferrer":false,"PreferredDeliveryDate":false,"IsSmart":false,"IsSpecialised":false},"Version":0},"AgentCriteria":{"Engine":[{"Badge":"String","Brand":"String"}],"Transmission":["String"],"Fuel":["String"],"Upholstery":["String"],"Equipment":["String"],"Line":["String"],"BodyStyle":["String"],"ColourGroup":["String"],"Packages":["String"],"Model":[{"Description":"String","Id":0}],"UrlReferrer":"String","PreferredDeliveryDate":"String","IsNewModel":false,"IsSmart":false,"IsSpecialised":false,"CriteriaDifference":{"Model":false,"Transmission":false,"Fuel":false,"Upholstery":false,"Equipment":false,"Line":false,"BodyStyle":false,"ColourGroup":false,"Packages":false,"Engine":false,"AdditionalInformation":false,"UrlReferrer":false,"PreferredDeliveryDate":false,"IsSmart":false,"IsSpecialised":false},"Version":0},"OutrightPurchase":{"IsOutrightPurchase":false,"Reference":"String","DiscountRate":0,"Bm7NST":"String","IsBackOrder":false,"IsCOPConverter":false},"GasId":"String","Motability":false,"MotabilityPricingId":0,"AssistanceProviderId":0,"AssistanceDetail":"String","ConfiguratorCode":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Guid":"String","Reference":"String","ConsentAgreedStatus":{"ConsentStatus":"String","ConsentSelected":{"String":false},"RecommendedAction":"String"},"MessageDelivered":false}