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
GetOrderCustomerRequest Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathstringYes
GetOrderCustomerResponse Parameters:
NameParameterData TypeRequiredDescription
OrdersformList<Order>Yes
CompletedformList<OnlineShowroomOrder>Yes
CancelledformList<OnlineShowroomOrder>Yes
InProgressformList<OnlineShowroomOrder>Yes
ArchivedformList<OnlineShowroomOrder>Yes
Order Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
ReferenceformstringYes
StatusformintNo
CustomerIdformstringYes
MulesoftReferenceformstringYes
GasIdformstringYes
OrderDateformstringYes
OfferSnapShotformstringYes
OnlineShowroomOrder Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
ReferenceformstringYes
StatusformList<OnlineShowroomStatus>Yes
VehicleformOnlineShowroomVehicleYes
ClosedDateformstringYes
CustomerIdformstringYes
HandoverDateformstringYes
ClosedReasonformstringYes
OrderDateformstringYes
PaymentLinksformList<PaymentDetail>Yes
OnlineShowroomStatus Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DescriptionformstringYes
SlugformstringYes
CurrentformboolNo
CompletedformboolNo
OrderStatusesformList<OrderStatus>Yes
OrderStatus Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DescriptionformstringYes
OnlineShowroomVehicle Parameters:
NameParameterData TypeRequiredDescription
VinformstringYes
VehicleClassformstringYes
TransmissionTypeformstringYes
FuelTypeformstringYes
ImageUrlformstringYes
ColourformstringYes
DescriptionformstringYes
BodyStyleformstringYes
UpholsteryTypeformstringYes
RetailerformRetailerYes
OTRformdecimalNo
ActualPriceformdecimalNo
TotalOfferValueformdecimalNo
NetPriceformdecimalNo
VehicleTypeformstringYes
OfferExpiryDateformstringNo
Retailer Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
GssnIdformstringYes
DescriptionformstringYes
StreetformstringYes
CityformstringYes
PostcodeformstringYes
GoogleMapPostcodeformstringYes
PhoneformstringYes
FaxformstringYes
EmailformstringYes
WebsiteformstringYes
RetailerGroupIdformstringYes
RetailerGroupNameformstringYes
IsOnlineformboolNo
IsNewCarRetailerformboolNo
IsUsedCarRetailerformboolNo
IsCentralRetailerformboolNo
ChatEnabledformboolNo
TradeInEnabledformboolNo
smartformboolNo
DisplayPhoneNumberNewformstringYes
DisplayPhoneNumberUsedformstringYes
LatitudeformdecimalNo
LongitudeformdecimalNo
smartDescriptionformstringYes
smartWebsiteformstringYes
smartPhoneformstringYes
LegacyIdformstringYes
AgentformboolNo
MarketAreaIdformintNo
DigitalLoungeParentGssnIdformstringNo
SendLeadsToDigitalLoungeParentformboolNo
OpeningTimesformRetailerOpeningTimesNo
RetailerOpeningTimes Parameters:
NameParameterData TypeRequiredDescription
NewformList<RetailerOpeningTime>Yes
UsedformList<RetailerOpeningTime>Yes
RetailerOpeningTime Parameters:
NameParameterData TypeRequiredDescription
DayformstringYes
OpenFromformstringYes
OpenToformstringYes
SpecialformstringYes
PaymentDetail Parameters:
NameParameterData TypeRequiredDescription
PaymentTypeformstringYes
PaymentLinkformstringYes

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}]}]}