Mercedes.Agency.Orchestration.API

CreateBackOrderRequest

BackOrder

The following routes are available for this service:
POST	/v1/backorder	Create Back Order (Online Showroom)	Create Back Order (Online Showroom)

**CreateBackOrderBase** Parameters:
Name	Parameter	Data Type	Required
GssnId	form	string	Yes
AdditionalInformation	form	string	Yes
ConfigCode	form	string	Yes
Source	form	Source	No
TagUrl	form	string	Yes
Customer	form	Customer	Yes
CustomerCriteria	form	Criteria	Yes
AgentCriteria	form	V2Criteria	Yes
OutrightPurchase	form	OutrightPurchase	No
GasId	form	string	Yes
Motability	form	bool	No
MotabilityPricingId	form	int?	No
AssistanceProviderId	form	int?	No
AssistanceDetail	form	string	No
ConfiguratorCode	form	string	No

**Source** Enum:
Name	Value
OnlineShowroom	1
OneAdmin	2

**Customer** Parameters:
Name	Parameter	Data Type	Required	Description
ProfileId	form	Guid?	No
Preferences	form	Preferences	No

**SalesforceCustomer** Parameters:
Name	Parameter	Data Type	Required
CustomerId	form	string	Yes
IsCiam	form	bool	No
CompanyName	form	string	Yes
Title	form	string	Yes
Firstname	form	string	Yes
Surname	form	string	Yes
EmailAddress	form	string	Yes
Telephone	form	string	Yes
Address	form	Address	Yes
Mode	form	CustomerMode	No

**Address** Parameters:
Name	Parameter	Data Type	Required
Property	form	string	Yes
Street	form	string	Yes
Town	form	string	Yes
County	form	string	Yes
Locality	form	string	Yes
Postcode	form	string	Yes

**CustomerMode** Enum:
Name	Value
Private	1
Business	2
Motability	3

**Preferences** Parameters:
Name	Parameter	Data Type	Required
OptinEmail	form	bool	No
OptinPost	form	bool	No
OptinSMS	form	bool	No
OptinTelephone	form	bool	No

**Criteria** Parameters:
Name	Parameter	Data Type	Required	Description
Engine	form	string[]	Yes

**CriteriaBase** Parameters:
Name	Parameter	Data Type	Required
Transmission	form	string[]	Yes
Fuel	form	string[]	Yes
Upholstery	form	string[]	Yes
Equipment	form	string[]	Yes
Line	form	string[]	Yes
BodyStyle	form	string[]	Yes
ColourGroup	form	string[]	Yes
Packages	form	string[]	Yes
Model	form	List<CriteriaModel>	Yes
UrlReferrer	form	string	Yes
PreferredDeliveryDate	form	string	Yes
IsNewModel	form	bool	No
IsSmart	form	bool	No
IsSpecialised	form	bool	No
CriteriaDifference	form	CriteriaDifference	Yes

**JsonVersion** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	int	No

**CriteriaModel** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	Yes
Id	form	int	No

**CriteriaDifference** Parameters:
Name	Parameter	Data Type	Required
Model	form	bool	No
Transmission	form	bool	No
Fuel	form	bool	No
Upholstery	form	bool	No
Equipment	form	bool	No
Line	form	bool	No
BodyStyle	form	bool	No
ColourGroup	form	bool	No
Packages	form	bool	No
Engine	form	bool	No
AdditionalInformation	form	bool	No
UrlReferrer	form	bool	No
PreferredDeliveryDate	form	bool	No
IsSmart	form	bool	No
IsSpecialised	form	bool	No

**V2Criteria** Parameters:
Name	Parameter	Data Type	Required	Description
Engine	form	List<V2EngineCriteria>	Yes

**V2EngineCriteria** Parameters:
Name	Parameter	Data Type	Required	Description
Badge	form	string	Yes
Brand	form	string	Yes

**OutrightPurchase** Parameters:
Name	Parameter	Data Type	Required
IsOutrightPurchase	form	bool	No
Reference	form	string	Yes
DiscountRate	form	decimal	No
Bm7NST	form	string	Yes
IsBackOrder	form	bool	No
IsCOPConverter	form	bool	No

**CreateBackOrderResponse** Parameters:
Name	Parameter	Data Type	Required
Guid	form	string	Yes
Reference	form	string	Yes
ConsentAgreedStatus	form	ConsentAgreedStatus	No
MessageDelivered	form	bool?	No

**ConsentAgreedStatus** Parameters:
Name	Parameter	Data Type	Required
ConsentStatus	form	string	Yes
ConsentSelected	form	Dictionary<string, bool>	Yes
RecommendedAction	form	string	No

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

HTTP + JSV

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

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