Mercedes.Agency.Orchestration.API

<back to all web services

GetOrderCustomerRequest

Order
Requires Authentication
The following routes are available for this service:
GET/v1/order/customer/{CustomerId}Get Order by Customer
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetOrderCustomerRequest : IGet
{
    open var CustomerId:String? = null
}

open class GetOrderCustomerResponse
{
    open var Orders:ArrayList<Order> = ArrayList<Order>()
    open var Completed:ArrayList<OnlineShowroomOrder> = ArrayList<OnlineShowroomOrder>()
    open var Cancelled:ArrayList<OnlineShowroomOrder> = ArrayList<OnlineShowroomOrder>()
    open var InProgress:ArrayList<OnlineShowroomOrder> = ArrayList<OnlineShowroomOrder>()
    open var Archived:ArrayList<OnlineShowroomOrder> = ArrayList<OnlineShowroomOrder>()
}

open class Order
{
    open var Guid:UUID? = null
    open var Reference:String? = null
    open var Status:Int? = null
    open var CustomerId:String? = null
    open var MulesoftReference:String? = null
    open var GasId:String? = null
    open var OrderDate:String? = null
    open var OfferSnapShot:String? = null
}

open class OnlineShowroomOrder
{
    open var Guid:UUID? = null
    open var Reference:String? = null
    open var Status:ArrayList<OnlineShowroomStatus> = ArrayList<OnlineShowroomStatus>()
    open var Vehicle:OnlineShowroomVehicle? = null
    open var ClosedDate:String? = null
    open var CustomerId:String? = null
    open var HandoverDate:String? = null
    open var ClosedReason:String? = null
    open var OrderDate:String? = null
    open var PaymentLinks:ArrayList<PaymentDetail> = ArrayList<PaymentDetail>()
}

open class OnlineShowroomStatus
{
    open var Id:Int? = null
    open var Description:String? = null
    open var Slug:String? = null
    open var Current:Boolean? = null
    open var Completed:Boolean? = null
    open var OrderStatuses:ArrayList<OrderStatus> = ArrayList<OrderStatus>()
}

open class OrderStatus
{
    open var Id:Int? = null
    open var Description:String? = null
}

open class OnlineShowroomVehicle
{
    open var Vin:String? = null
    open var VehicleClass:String? = null
    open var TransmissionType:String? = null
    open var FuelType:String? = null
    open var ImageUrl:String? = null
    open var Colour:String? = null
    open var Description:String? = null
    open var BodyStyle:String? = null
    open var UpholsteryType:String? = null
    open var Retailer:Retailer? = null
    open var OTR:BigDecimal? = null
    open var ActualPrice:BigDecimal? = null
    open var TotalOfferValue:BigDecimal? = null
    open var NetPrice:BigDecimal? = null
    open var VehicleType:String? = null
    open var OfferExpiryDate:String? = null
}

open class Retailer
{
    open var Id:Int? = null
    open var GssnId:String? = null
    open var Description:String? = null
    open var Street:String? = null
    open var City:String? = null
    open var Postcode:String? = null
    open var GoogleMapPostcode:String? = null
    open var Phone:String? = null
    open var Fax:String? = null
    open var Email:String? = null
    open var Website:String? = null
    open var RetailerGroupId:String? = null
    open var RetailerGroupName:String? = null
    open var IsOnline:Boolean? = null
    open var IsNewCarRetailer:Boolean? = null
    open var IsUsedCarRetailer:Boolean? = null
    open var IsCentralRetailer:Boolean? = null
    open var ChatEnabled:Boolean? = null
    open var TradeInEnabled:Boolean? = null
    open var smart:Boolean? = null
    open var DisplayPhoneNumberNew:String? = null
    open var DisplayPhoneNumberUsed:String? = null
    open var Latitude:BigDecimal? = null
    open var Longitude:BigDecimal? = null
    open var smartDescription:String? = null
    open var smartWebsite:String? = null
    open var smartPhone:String? = null
    open var LegacyId:String? = null
    open var Agent:Boolean? = null
    open var MarketAreaId:Int? = null
    open var DigitalLoungeParentGssnId:String? = null
    open var SendLeadsToDigitalLoungeParent:Boolean? = null
    open var OpeningTimes:RetailerOpeningTimes? = null
}

open class RetailerOpeningTimes
{
    open var New:ArrayList<RetailerOpeningTime> = ArrayList<RetailerOpeningTime>()
    open var Used:ArrayList<RetailerOpeningTime> = ArrayList<RetailerOpeningTime>()
}

open class RetailerOpeningTime
{
    open var Day:String? = null
    open var OpenFrom:String? = null
    open var OpenTo:String? = null
    open var Special:String? = null
}

open class PaymentDetail
{
    open var PaymentType:String? = null
    open var PaymentLink:String? = null
}

Kotlin GetOrderCustomerRequest DTOs

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
				}
			]
		}
	]
}