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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Responses
Imports Mercedes.Agency.API.Shared.POCO

Namespace Global

    Namespace Mercedes.Agency.API.Shared.POCO

        Public Partial Class OnlineShowroomOrder
            Public Overridable Property Guid As Guid
            Public Overridable Property Reference As String
            Public Overridable Property Status As List(Of OnlineShowroomStatus) = New List(Of OnlineShowroomStatus)
            Public Overridable Property Vehicle As OnlineShowroomVehicle
            Public Overridable Property ClosedDate As String
            Public Overridable Property CustomerId As String
            Public Overridable Property HandoverDate As String
            Public Overridable Property ClosedReason As String
            Public Overridable Property OrderDate As String
            Public Overridable Property PaymentLinks As List(Of PaymentDetail) = New List(Of PaymentDetail)
        End Class

        Public Partial Class OnlineShowroomStatus
            Public Overridable Property Id As Integer
            Public Overridable Property Description As String
            Public Overridable Property Slug As String
            Public Overridable Property Current As Boolean
            Public Overridable Property Completed As Boolean
            Public Overridable Property OrderStatuses As List(Of OrderStatus) = New List(Of OrderStatus)
        End Class

        Public Partial Class OnlineShowroomVehicle
            Public Overridable Property Vin As String
            Public Overridable Property VehicleClass As String
            Public Overridable Property TransmissionType As String
            Public Overridable Property FuelType As String
            Public Overridable Property ImageUrl As String
            Public Overridable Property Colour As String
            Public Overridable Property Description As String
            Public Overridable Property BodyStyle As String
            Public Overridable Property UpholsteryType As String
            Public Overridable Property Retailer As Retailer
            Public Overridable Property OTR As Decimal
            Public Overridable Property ActualPrice As Decimal
            Public Overridable Property TotalOfferValue As Decimal
            Public Overridable Property NetPrice As Decimal
            Public Overridable Property VehicleType As String
            Public Overridable Property OfferExpiryDate As String
        End Class

        Public Partial Class Order
            Public Overridable Property Guid As Guid
            Public Overridable Property Reference As String
            Public Overridable Property Status As Integer
            Public Overridable Property CustomerId As String
            Public Overridable Property MulesoftReference As String
            Public Overridable Property GasId As String
            Public Overridable Property OrderDate As String
            Public Overridable Property OfferSnapShot As String
        End Class

        Public Partial Class OrderStatus
            Public Overridable Property Id As Integer
            Public Overridable Property Description As String
        End Class

        Public Partial Class PaymentDetail
            Public Overridable Property PaymentType As String
            Public Overridable Property PaymentLink As String
        End Class

        Public Partial Class Retailer
            Public Overridable Property Id As Integer
            Public Overridable Property GssnId As String
            Public Overridable Property Description As String
            Public Overridable Property Street As String
            Public Overridable Property City As String
            Public Overridable Property Postcode As String
            Public Overridable Property GoogleMapPostcode As String
            Public Overridable Property Phone As String
            Public Overridable Property Fax As String
            Public Overridable Property Email As String
            Public Overridable Property Website As String
            Public Overridable Property RetailerGroupId As String
            Public Overridable Property RetailerGroupName As String
            Public Overridable Property IsOnline As Boolean
            Public Overridable Property IsNewCarRetailer As Boolean
            Public Overridable Property IsUsedCarRetailer As Boolean
            Public Overridable Property IsCentralRetailer As Boolean
            Public Overridable Property ChatEnabled As Boolean
            Public Overridable Property TradeInEnabled As Boolean
            Public Overridable Property smart As Boolean
            Public Overridable Property DisplayPhoneNumberNew As String
            Public Overridable Property DisplayPhoneNumberUsed As String
            Public Overridable Property Latitude As Decimal
            Public Overridable Property Longitude As Decimal
            Public Overridable Property smartDescription As String
            Public Overridable Property smartWebsite As String
            Public Overridable Property smartPhone As String
            Public Overridable Property LegacyId As String
            Public Overridable Property Agent As Boolean
            Public Overridable Property MarketAreaId As Integer
            Public Overridable Property DigitalLoungeParentGssnId As String
            Public Overridable Property SendLeadsToDigitalLoungeParent As Boolean
            Public Overridable Property OpeningTimes As RetailerOpeningTimes
        End Class

        Public Partial Class RetailerOpeningTime
            Public Overridable Property Day As String
            Public Overridable Property OpenFrom As String
            Public Overridable Property OpenTo As String
            Public Overridable Property Special As String
        End Class

        Public Partial Class RetailerOpeningTimes
            Public Overridable Property [New] As List(Of RetailerOpeningTime) = New List(Of RetailerOpeningTime)
            Public Overridable Property Used As List(Of RetailerOpeningTime) = New List(Of RetailerOpeningTime)
        End Class
    End Namespace

    Namespace Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Responses

        Public Partial Class GetOrderCustomerRequest
            Implements IGet
            Public Overridable Property CustomerId As String
        End Class

        Public Partial Class GetOrderCustomerResponse
            Public Overridable Property Orders As List(Of Order) = New List(Of Order)
            Public Overridable Property Completed As List(Of OnlineShowroomOrder) = New List(Of OnlineShowroomOrder)
            Public Overridable Property Cancelled As List(Of OnlineShowroomOrder) = New List(Of OnlineShowroomOrder)
            Public Overridable Property InProgress As List(Of OnlineShowroomOrder) = New List(Of OnlineShowroomOrder)
            Public Overridable Property Archived As List(Of OnlineShowroomOrder) = New List(Of OnlineShowroomOrder)
        End Class
    End Namespace
End Namespace

VB.NET GetOrderCustomerRequest DTOs

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