Mercedes.Agency.Orchestration.API

GetOrderCustomerRequest

Order

The following routes are available for this service:
GET	/v1/order/customer/{CustomerId}		Get Order by Customer

**GetOrderCustomerRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerId	path	string	Yes

**GetOrderCustomerResponse** Parameters:
Name	Parameter	Data Type	Required
Orders	form	List<Order>	Yes
Completed	form	List<OnlineShowroomOrder>	Yes
Cancelled	form	List<OnlineShowroomOrder>	Yes
InProgress	form	List<OnlineShowroomOrder>	Yes
Archived	form	List<OnlineShowroomOrder>	Yes

**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

**OnlineShowroomOrder** Parameters:
Name	Parameter	Data Type	Required
Guid	form	Guid	No
Reference	form	string	Yes
Status	form	List<OnlineShowroomStatus>	Yes
Vehicle	form	OnlineShowroomVehicle	Yes
ClosedDate	form	string	Yes
CustomerId	form	string	Yes
HandoverDate	form	string	Yes
ClosedReason	form	string	Yes
OrderDate	form	string	Yes
PaymentLinks	form	List<PaymentDetail>	Yes

**OnlineShowroomStatus** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Description	form	string	Yes
Slug	form	string	Yes
Current	form	bool	No
Completed	form	bool	No
OrderStatuses	form	List<OrderStatus>	Yes

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

**OnlineShowroomVehicle** Parameters:
Name	Parameter	Data Type	Required
Vin	form	string	Yes
VehicleClass	form	string	Yes
TransmissionType	form	string	Yes
FuelType	form	string	Yes
ImageUrl	form	string	Yes
Colour	form	string	Yes
Description	form	string	Yes
BodyStyle	form	string	Yes
UpholsteryType	form	string	Yes
Retailer	form	Retailer	Yes
OTR	form	decimal	No
ActualPrice	form	decimal	No
TotalOfferValue	form	decimal	No
NetPrice	form	decimal	No
VehicleType	form	string	Yes
OfferExpiryDate	form	string	No

**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

**PaymentDetail** Parameters:
Name	Parameter	Data Type	Required	Description
PaymentType	form	string	Yes
PaymentLink	form	string	Yes

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.

GET /v1/order/customer/{CustomerId} HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/jsv

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

{
	Orders: 
	[
		{
			Guid: 00000000000000000000000000000000,
			Reference: String,
			Status: 0,
			CustomerId: String,
			MulesoftReference: String,
			GasId: String,
			OrderDate: String,
			OfferSnapShot: String
		}
	],
	Completed: 
	[
		{
			Guid: 00000000000000000000000000000000,
			Reference: String,
			Status: 
			[
				{
					Id: 0,
					Description: String,
					Slug: String,
					Current: False,
					Completed: False,
					OrderStatuses: 
					[
						{
							Id: 0,
							Description: String
						}
					]
				}
			],
			Vehicle: 
			{
				Vin: String,
				VehicleClass: String,
				TransmissionType: String,
				FuelType: String,
				ImageUrl: String,
				Colour: String,
				Description: String,
				BodyStyle: String,
				UpholsteryType: 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
							}
						]
					}
				},
				OTR: 0,
				ActualPrice: 0,
				TotalOfferValue: 0,
				NetPrice: 0,
				VehicleType: String,
				OfferExpiryDate: String
			},
			ClosedDate: String,
			CustomerId: String,
			HandoverDate: String,
			ClosedReason: String,
			OrderDate: String,
			PaymentLinks: 
			[
				{
					PaymentType: String,
					PaymentLink: String
				}
			]
		}
	],
	Cancelled: 
	[
		{
			Guid: 00000000000000000000000000000000,
			Reference: String,
			Status: 
			[
				{
					Id: 0,
					Description: String,
					Slug: String,
					Current: False,
					Completed: False,
					OrderStatuses: 
					[
						{
							Id: 0,
							Description: String
						}
					]
				}
			],
			Vehicle: 
			{
				Vin: String,
				VehicleClass: String,
				TransmissionType: String,
				FuelType: String,
				ImageUrl: String,
				Colour: String,
				Description: String,
				BodyStyle: String,
				UpholsteryType: 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
							}
						]
					}
				},
				OTR: 0,
				ActualPrice: 0,
				TotalOfferValue: 0,
				NetPrice: 0,
				VehicleType: String,
				OfferExpiryDate: String
			},
			ClosedDate: String,
			CustomerId: String,
			HandoverDate: String,
			ClosedReason: String,
			OrderDate: String,
			PaymentLinks: 
			[
				{
					PaymentType: String,
					PaymentLink: String
				}
			]
		}
	],
	InProgress: 
	[
		{
			Guid: 00000000000000000000000000000000,
			Reference: String,
			Status: 
			[
				{
					Id: 0,
					Description: String,
					Slug: String,
					Current: False,
					Completed: False,
					OrderStatuses: 
					[
						{
							Id: 0,
							Description: String
						}
					]
				}
			],
			Vehicle: 
			{
				Vin: String,
				VehicleClass: String,
				TransmissionType: String,
				FuelType: String,
				ImageUrl: String,
				Colour: String,
				Description: String,
				BodyStyle: String,
				UpholsteryType: 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
							}
						]
					}
				},
				OTR: 0,
				ActualPrice: 0,
				TotalOfferValue: 0,
				NetPrice: 0,
				VehicleType: String,
				OfferExpiryDate: String
			},
			ClosedDate: String,
			CustomerId: String,
			HandoverDate: String,
			ClosedReason: String,
			OrderDate: String,
			PaymentLinks: 
			[
				{
					PaymentType: String,
					PaymentLink: String
				}
			]
		}
	],
	Archived: 
	[
		{
			Guid: 00000000000000000000000000000000,
			Reference: String,
			Status: 
			[
				{
					Id: 0,
					Description: String,
					Slug: String,
					Current: False,
					Completed: False,
					OrderStatuses: 
					[
						{
							Id: 0,
							Description: String
						}
					]
				}
			],
			Vehicle: 
			{
				Vin: String,
				VehicleClass: String,
				TransmissionType: String,
				FuelType: String,
				ImageUrl: String,
				Colour: String,
				Description: String,
				BodyStyle: String,
				UpholsteryType: 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
							}
						]
					}
				},
				OTR: 0,
				ActualPrice: 0,
				TotalOfferValue: 0,
				NetPrice: 0,
				VehicleType: String,
				OfferExpiryDate: String
			},
			ClosedDate: String,
			CustomerId: String,
			HandoverDate: String,
			ClosedReason: String,
			OrderDate: String,
			PaymentLinks: 
			[
				{
					PaymentType: String,
					PaymentLink: String
				}
			]
		}
	]
}