Mercedes.Agency.Orchestration.API

GetActiveBackOrderCsvRequest

BackOrder

The following routes are available for this service:
GET	/v1/backorder/active	Get Active Back Order
GET	/v1/backorder/active/csv	Get Active Back Order
GET	/v1/backorder/active/{GssnId}	Get Active Back Order
GET	/v1/backorder/active/csv/{GssnId}	Get Active Back Order

**GetActiveBackOrderRequest** Parameters:
Name	Parameter	Data Type	Required	Description
GssnId	form	string	Yes

**GetActiveBackOrderResponse** Parameters:
Name	Parameter	Data Type	Required
BackOrders	form	List<BackOrder>	No
FilteredGssn	form	string	Yes
FilteredRetailer	form	string	Yes

**BackOrder** Parameters:
Name	Parameter	Data Type	Required	Description
Vehicle	form	VehicleDetail	Yes

**BackOrderBase** Parameters:
Name	Parameter	Data Type	Required
Guid	form	string	Yes
Status	form	int	No
CustomerId	form	string	Yes
Id	form	int	No
Reference	form	string	Yes
Agent	form	string	Yes
Gssn	form	string	Yes
CreationDate	form	DateTime	No
MaintenanceDate	form	DateTime	No
CustomerCriteria	form	string	Yes
AgentCriteria	form	string	No
History	form	List<BackOrderHistory>	No
IsAllocatedToOrder	form	bool	No
Vin	form	string	Yes
CommissionNumber	form	string	No
Order	form	Order	No
Source	form	string	Yes
Specialist	form	bool	No
OutrightPurchase	form	bool	No
Sellable	form	bool	No
MulesoftReference	form	string	Yes
AdditionalInformation	form	string	Yes
ConfigCode	form	string	Yes
FleetBaseOrder	form	string	Yes
GasId	form	string	Yes
OutrightPurchaseCustomerIdentifier	form	string	Yes
Retailer	form	Retailer	Yes
CustomerMode	form	int	No
CanEdit	form	bool	No
DigitalLoungeGssnId	form	string	No
DigitalLounge	form	string	No
Motability	form	bool	No
MotabilityPricing	form	MotabilityPricing	No
LinkedByUserType	form	string	No
AssistanceProviderId	form	int?	No
AssistanceProvider	form	string	No
AssistanceDetail	form	string	No
LastAssistanceMessageDate	form	DateTime?	No
LastAssistanceUser	form	string	No
IsCOPConverter	form	bool	No
IsEligibleCOPConverter	form	bool	No
CarConfigurator	form	CarConfigurator	No
CarConfiguratorResponse	form	CarConfiguratorResponse	No

**BackOrderHistory** Parameters:
Name	Parameter	Data Type	Required
Status	form	int	No
CommissionNumber	form	string	No
VIN	form	string	No
CustomerCriteria	form	string	Yes
AgentCriteria	form	string	Yes
CreationDate	form	DateTime	No
MaintenanceDate	form	DateTime	No
GasId	form	string	Yes
Sellable	form	bool	No
AdditionalInformation	form	string	Yes
Reason	form	string	Yes
ConfigCode	form	string	Yes
FleetBaseOrder	form	string	Yes
AssistanceDetail	form	string	No
AssistanceProvider	form	string	No
LinkedByUserType	form	string	No
MotabilityVTN	form	string	No
MotabilityBackOrderDropDown	form	string	No
MotabilityValidFrom	form	DateTime?	No
MotabilityValidTo	form	DateTime?	No

**Order** Parameters:
Name	Parameter	Data Type	Required
Guid	form	Guid	No
Reference	form	string	Yes
Status	form	int	No
CustomerId	form	string	Yes
MulesoftReference	form	string	Yes
GasId	form	string	Yes
OrderDate	form	string	Yes
OfferSnapShot	form	string	Yes

**Retailer** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
GssnId	form	string	Yes
Description	form	string	Yes
Street	form	string	Yes
City	form	string	Yes
Postcode	form	string	Yes
GoogleMapPostcode	form	string	Yes
Phone	form	string	Yes
Fax	form	string	Yes
Email	form	string	Yes
Website	form	string	Yes
RetailerGroupId	form	string	Yes
RetailerGroupName	form	string	Yes
IsOnline	form	bool	No
IsNewCarRetailer	form	bool	No
IsUsedCarRetailer	form	bool	No
IsCentralRetailer	form	bool	No
ChatEnabled	form	bool	No
TradeInEnabled	form	bool	No
smart	form	bool	No
DisplayPhoneNumberNew	form	string	Yes
DisplayPhoneNumberUsed	form	string	Yes
Latitude	form	decimal	No
Longitude	form	decimal	No
smartDescription	form	string	Yes
smartWebsite	form	string	Yes
smartPhone	form	string	Yes
LegacyId	form	string	Yes
Agent	form	bool	No
MarketAreaId	form	int	No
DigitalLoungeParentGssnId	form	string	No
SendLeadsToDigitalLoungeParent	form	bool	No
OpeningTimes	form	RetailerOpeningTimes	No

**RetailerOpeningTimes** Parameters:
Name	Parameter	Data Type	Required	Description
New	form	List<RetailerOpeningTime>	Yes
Used	form	List<RetailerOpeningTime>	Yes

**RetailerOpeningTime** Parameters:
Name	Parameter	Data Type	Required
Day	form	string	Yes
OpenFrom	form	string	Yes
OpenTo	form	string	Yes
Special	form	string	Yes

**MotabilityPricing** Parameters:
Name	Parameter	Data Type	Required	Description
MotabilityPricingStatus	form	MotabilityPricingStatus	No

**MotabilityPricingCsv** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CriteriaBM7NST	form	string	Yes
VTN	form	string	Yes
BackOrderDropDown	form	string	Yes
CriteriaFullModelYearCode	form	string	Yes
CriteriaValidOptionCodes	form	string	No
CriteriaInvalidOptionCodes	form	string	No
PIPNet	form	decimal	No
PIPVat	form	decimal	No
PIPGross	form	decimal	No
WPMSNet	form	decimal	No
WPMSVat	form	decimal	No
WPMSGross	form	decimal	No
DiscountNet	form	decimal	No
DiscountVat	form	decimal	No
DiscountGross	form	decimal	No
ListPriceNet	form	decimal	No
ListPriceVat	form	decimal	No
ListPriceGross	form	decimal	No
DeliveryChargeNet	form	decimal	No
DeliveryChargeVat	form	decimal	No
DeliveryChargeGross	form	decimal	No
FuelChargeNet	form	decimal	No
FuelChargeVat	form	decimal	No
FuelChargeGross	form	decimal	No
NumberPlateFeeNet	form	decimal	No
NumberPlateFeeVat	form	decimal	No
NumberPlateFeeGross	form	decimal	No
FirstRegistrationFeeNet	form	decimal	No
FirstRegistrationFeeVat	form	decimal	No
FirstRegistrationFeeGross	form	decimal	No
RoadFundLicenceNet	form	decimal	No
RoadFundLicenceVat	form	decimal	No
RoadFundLicenceGross	form	decimal	No
ValidFrom	form	DateTime	No
ValidTo	form	DateTime	No

**MotabilityPricingStatus** Enum:
Pending	Pending
Current	Current
RecentlyExpired	RecentlyExpired
Expired	Expired

**CarConfigurator** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
BackOrderId	form	int?	No
ConfiguratorCode	form	string	Yes
GasId	form	string	No
Status	form	int	No
DateOfLastUpdate	form	DateTime	No
LastExceptionMessage	form	string	No
LastException	form	string	No

**CarConfiguratorResponse** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
KeyInformation	form	KeyInformation	No
OrderingOptions	form	OrderingOptions	No
ResponseStatus	form	ResponseStatus	Yes
ConfiguratorCode	form	string	No

**KeyInformation** Parameters:
Name	Parameter	Data Type	Required
BM7NST	form	string	No
ConfigurationDate	form	string	No
ModelYear	form	string	No
HalfYear	form	string	No

**OrderingOptions** Parameters:
Name	Parameter	Data Type	Required
Interior	form	List<string>	No
Exterior	form	List<string>	No
Other	form	List<string>	No

**VehicleDetail** Parameters:
Name	Parameter	Data Type	Required
RetailPrice_ExVAT	form	string	Yes
OTR	form	string	Yes
ActualPrice	form	string	Yes
TotalOfferValue	form	string	Yes
IsHOBackOrderAccountVehicle	form	bool	No
ConsumptionCombined	form	VehicleConsumption	No
ConsumptionExtraUrban	form	VehicleConsumption	No
ConsumptionUrban	form	VehicleConsumption	No
WltpFuelConsumptionCombined	form	VehicleConsumption	No
WltpFuelConsumptionExtraHigh	form	VehicleConsumption	No
WltpFuelConsumptionHigh	form	VehicleConsumption	No
WltpFuelConsumptionLow	form	VehicleConsumption	No
WltpFuelConsumptionMedium	form	VehicleConsumption	No
EquipmentCategories	form	List<VehicleEquipmentCategory>	No
VehicleEnergyEfficiencyClass	form	VehicleEmissionClass	No
VehicleData	form	List<VehicleAttribute>	No
IntegratedProducts	form	List<VehicleIntegratedServiceCareOption>	Yes
IspVehicleCustomerDescriptions	form	List<string>	No
ColourCode	form	string	Yes
UpholsteryCode	form	string	Yes

**VehicleBaseDetail** Parameters:
Name	Parameter	Data Type	Required
Description	form	string	Yes
CommissionNumber	form	string	Yes
PortArrivalDate	form	string	Yes
OfferExpiryDate	form	string	Yes
Fuel	form	string	Yes
Transmission	form	string	Yes
TransmissionType	form	string	Yes
Colour	form	string	Yes
ColourDescription	form	string	Yes
ImageUrl	form	string	Yes
Specialist	form	bool	No
VehicleCriteriaMatch	form	VehicleCriteriaMatch	No
ColourGroup	form	string	Yes
Model	form	string	Yes
BodyStyle	form	string	Yes
Brand	form	string	Yes
Engine	form	string	Yes
EngineDescription	form	string	Yes
Line	form	string	Yes
Upholstery	form	string	Yes
UpholsteryDescription	form	string	Yes
Packages	form	List<string>	Yes
P11D	form	decimal	No
Prices	form	List<Price>	Yes
VehicleClass	form	string	Yes
ProductRange	form	string	Yes
VehicleType	form	string	Yes
Emission	form	decimal?	No
Baumuster	form	string	Yes
IsSellable	form	bool	No
Bm7NST	form	string	Yes
ElectricRange	form	decimal?	No
ElectricConsumption	form	decimal?	No
IsDisplayStock	form	bool	No
DisplayRetailer_Id	form	int?	No
DisplayRetailer	form	string	Yes
DisplayRetailerGssnId	form	string	Yes
Retailer	form	Retailer	Yes
Age	form	int?	No
ModelYearCode	form	string	Yes
HalfModelYearCode	form	string	Yes
FullModelYearCode	form	string	Yes
ProductionDate	form	string	Yes
ChassisNumber	form	string	No
EligibleForIntegratedServiceCare	form	bool	No

**Vehicle** Parameters:
Name	Parameter	Data Type	Required	Description
Vin	form	string	No

**VehicleCriteriaMatch** Parameters:
Name	Parameter	Data Type	Required
Fuel	form	bool	No
Transmission	form	bool	No
Colour	form	bool	No
Upholstery	form	bool	No
Line	form	bool	No
Engine	form	bool	No
BodyStyle	form	bool	No
Packages	form	bool	No

**Price** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	Yes
Description	form	string	Yes
Net	form	decimal	No
VAT	form	decimal	No
Gross	form	decimal	No
Product	form	OfferPriceProductType	No

**OfferPriceProductType** Enum:
LIST_PRICE
NUMBER_PLATE_FEE
DELIVERY_CHARGE
FUEL_CHARGE
MANUFACTURER_OFFER
PERSONALISED_MONEYOFFER
PERSONALISED_NONMONEYOFFER
PERSONALISED_NONMONEYOFFER_NEG
SERVICE
SERVICE_NEG
GOVERNMENT_GRANT
OUTRIGHT_PURCHASE_DISCOUNT
VIP_OFFER
WALLBOX_OFFER
WALLBOX_OFFER_NEG
ROAD_FUND_LICENCE
FIRST_REGISTRATION_FEE
NOT_FOUND
ACCESSORY_OFFER
ACCESSORY_OFFER_NEG
MOTABILITY_DISCOUNT

**VehicleConsumption** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Lkm	form	decimal	No
Mpg	form	decimal	No

**VehicleEquipmentCategory** Parameters:
Name	Parameter	Data Type	Required
Order	form	int	No
Code	form	string	No
Description	form	string	No
Equipment	form	List<Equipmentv2>	No

**Equipmentv2** Parameters:
Name	Parameter	Data Type	Required	Description
Importance	form	int	No
IsAdditional	form	bool	No

**Equipment** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Code	form	string	No
Description	form	string	No

**VehicleEmissionClass** Parameters:
Name	Parameter	Data Type	Required	Description
Colour	form	string	No
Rating	form	string	No

**VehicleAttribute** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	No
Value	form	string	No

**VehicleIntegratedServiceCareOption** Parameters:
Name	Parameter	Data Type	Required
OptionCode	form	string	No
BM7NST	form	string	No
FullModelYear	form	string	No
IntegratedProductType	form	string	No
CustomerDescription	form	string	No
OneAgentProductType	form	string	No

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.

GET /v1/backorder/active HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/csv

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

{"BackOrders":[{"Vehicle":{"RetailPrice_ExVAT":"String","OTR":"String","ActualPrice":"String","TotalOfferValue":"String","IsHOBackOrderAccountVehicle":false,"ConsumptionCombined":{"Id":0,"Lkm":0,"Mpg":0},"ConsumptionExtraUrban":{"Id":0,"Lkm":0,"Mpg":0},"ConsumptionUrban":{"Id":0,"Lkm":0,"Mpg":0},"WltpFuelConsumptionCombined":{"Id":0,"Lkm":0,"Mpg":0},"WltpFuelConsumptionExtraHigh":{"Id":0,"Lkm":0,"Mpg":0},"WltpFuelConsumptionHigh":{"Id":0,"Lkm":0,"Mpg":0},"WltpFuelConsumptionLow":{"Id":0,"Lkm":0,"Mpg":0},"WltpFuelConsumptionMedium":{"Id":0,"Lkm":0,"Mpg":0},"EquipmentCategories":[{"Order":0,"Code":"String","Description":"String","Equipment":[{"Importance":0,"IsAdditional":false,"Id":0,"Code":"String","Description":"String"}]}],"VehicleEnergyEfficiencyClass":{"Colour":"String","Rating":"String"},"VehicleData":[{"Description":"String","Value":"String"}],"IntegratedProducts":[{"OptionCode":"String","BM7NST":"String","FullModelYear":"String","IntegratedProductType":"String","CustomerDescription":"String","OneAgentProductType":"String"}],"IspVehicleCustomerDescriptions":["String"],"ColourCode":"String","UpholsteryCode":"String","Description":"String","CommissionNumber":"String","PortArrivalDate":"String","OfferExpiryDate":"String","Fuel":"String","Transmission":"String","TransmissionType":"String","Colour":"String","ColourDescription":"String","ImageUrl":"String","Specialist":false,"VehicleCriteriaMatch":{"Fuel":false,"Transmission":false,"Colour":false,"Upholstery":false,"Line":false,"Engine":false,"BodyStyle":false,"Packages":false},"ColourGroup":"String","Model":"String","BodyStyle":"String","Brand":"String","Engine":"String","EngineDescription":"String","Line":"String","Upholstery":"String","UpholsteryDescription":"String","Packages":["String"],"P11D":0,"Prices":[{"Id":"String","Description":"String","Net":0,"VAT":0,"Gross":0,"Product":"LIST_PRICE"}],"VehicleClass":"String","ProductRange":"String","VehicleType":"String","Emission":0,"Baumuster":"String","IsSellable":false,"Bm7NST":"String","ElectricRange":0,"ElectricConsumption":0,"IsDisplayStock":false,"DisplayRetailer_Id":0,"DisplayRetailer":"String","DisplayRetailerGssnId":"String","Retailer":{"Id":0,"GssnId":"String","Description":"String","Street":"String","City":"String","Postcode":"String","GoogleMapPostcode":"String","Phone":"String","Fax":"String","Email":"String","Website":"String","RetailerGroupId":"String","RetailerGroupName":"String","IsOnline":false,"IsNewCarRetailer":false,"IsUsedCarRetailer":false,"IsCentralRetailer":false,"ChatEnabled":false,"TradeInEnabled":false,"smart":false,"DisplayPhoneNumberNew":"String","DisplayPhoneNumberUsed":"String","Latitude":0,"Longitude":0,"smartDescription":"String","smartWebsite":"String","smartPhone":"String","LegacyId":"String","Agent":false,"MarketAreaId":0,"DigitalLoungeParentGssnId":"String","SendLeadsToDigitalLoungeParent":false,"OpeningTimes":{"New":[{"Day":"String","OpenFrom":"String","OpenTo":"String","Special":"String"}],"Used":[{"Day":"String","OpenFrom":"String","OpenTo":"String","Special":"String"}]}},"Age":0,"ModelYearCode":"String","HalfModelYearCode":"String","FullModelYearCode":"String","ProductionDate":"String","ChassisNumber":"String","EligibleForIntegratedServiceCare":false,"Vin":"String"},"Guid":"String","Status":0,"CustomerId":"String","Id":0,"Reference":"String","Agent":"String","Gssn":"String","CreationDate":"\/Date(-62135596800000-0000)\/","MaintenanceDate":"\/Date(-62135596800000-0000)\/","CustomerCriteria":"String","AgentCriteria":"String","History":[{"Status":0,"CommissionNumber":"String","VIN":"String","CustomerCriteria":"String","AgentCriteria":"String","CreationDate":"\/Date(-62135596800000-0000)\/","MaintenanceDate":"\/Date(-62135596800000-0000)\/","GasId":"String","Sellable":false,"AdditionalInformation":"String","Reason":"String","ConfigCode":"String","FleetBaseOrder":"String","AssistanceDetail":"String","AssistanceProvider":"String","LinkedByUserType":"String","MotabilityVTN":"String","MotabilityBackOrderDropDown":"String","MotabilityValidFrom":"\/Date(-62135596800000-0000)\/","MotabilityValidTo":"\/Date(-62135596800000-0000)\/"}],"IsAllocatedToOrder":false,"Vin":"String","CommissionNumber":"String","Order":{"Guid":"00000000000000000000000000000000","Reference":"String","Status":0,"CustomerId":"String","MulesoftReference":"String","GasId":"String","OrderDate":"String","OfferSnapShot":"String"},"Source":"String","Specialist":false,"OutrightPurchase":false,"Sellable":false,"MulesoftReference":"String","AdditionalInformation":"String","ConfigCode":"String","FleetBaseOrder":"String","GasId":"String","OutrightPurchaseCustomerIdentifier":"String","Retailer":{"Id":0,"GssnId":"String","Description":"String","Street":"String","City":"String","Postcode":"String","GoogleMapPostcode":"String","Phone":"String","Fax":"String","Email":"String","Website":"String","RetailerGroupId":"String","RetailerGroupName":"String","IsOnline":false,"IsNewCarRetailer":false,"IsUsedCarRetailer":false,"IsCentralRetailer":false,"ChatEnabled":false,"TradeInEnabled":false,"smart":false,"DisplayPhoneNumberNew":"String","DisplayPhoneNumberUsed":"String","Latitude":0,"Longitude":0,"smartDescription":"String","smartWebsite":"String","smartPhone":"String","LegacyId":"String","Agent":false,"MarketAreaId":0,"DigitalLoungeParentGssnId":"String","SendLeadsToDigitalLoungeParent":false,"OpeningTimes":{"New":[{"Day":"String","OpenFrom":"String","OpenTo":"String","Special":"String"}],"Used":[{"Day":"String","OpenFrom":"String","OpenTo":"String","Special":"String"}]}},"CustomerMode":0,"CanEdit":false,"DigitalLoungeGssnId":"String","DigitalLounge":"String","Motability":false,"MotabilityPricing":{"MotabilityPricingStatus":"Pending","Id":0,"CriteriaBM7NST":"String","VTN":"String","BackOrderDropDown":"String","CriteriaFullModelYearCode":"String","CriteriaValidOptionCodes":"String","CriteriaInvalidOptionCodes":"String","PIPNet":0,"PIPVat":0,"PIPGross":0,"WPMSNet":0,"WPMSVat":0,"WPMSGross":0,"DiscountNet":0,"DiscountVat":0,"DiscountGross":0,"ListPriceNet":0,"ListPriceVat":0,"ListPriceGross":0,"DeliveryChargeNet":0,"DeliveryChargeVat":0,"DeliveryChargeGross":0,"FuelChargeNet":0,"FuelChargeVat":0,"FuelChargeGross":0,"NumberPlateFeeNet":0,"NumberPlateFeeVat":0,"NumberPlateFeeGross":0,"FirstRegistrationFeeNet":0,"FirstRegistrationFeeVat":0,"FirstRegistrationFeeGross":0,"RoadFundLicenceNet":0,"RoadFundLicenceVat":0,"RoadFundLicenceGross":0,"ValidFrom":"\/Date(-62135596800000-0000)\/","ValidTo":"\/Date(-62135596800000-0000)\/"},"LinkedByUserType":"String","AssistanceProviderId":0,"AssistanceProvider":"String","AssistanceDetail":"String","LastAssistanceMessageDate":"\/Date(-62135596800000-0000)\/","LastAssistanceUser":"String","IsCOPConverter":false,"IsEligibleCOPConverter":false,"CarConfigurator":{"Id":0,"BackOrderId":0,"ConfiguratorCode":"String","GasId":"String","Status":0,"DateOfLastUpdate":"\/Date(-62135596800000-0000)\/","LastExceptionMessage":"String","LastException":"String"},"CarConfiguratorResponse":{"Name":"String","KeyInformation":{"BM7NST":"String","ConfigurationDate":"String","ModelYear":"String","HalfYear":"String"},"OrderingOptions":{"Interior":["String"],"Exterior":["String"],"Other":["String"]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ConfiguratorCode":"String"}}],"FilteredGssn":"String","FilteredRetailer":"String"}