Mercedes.Agency.Orchestration.API

<back to all web services

UpdateVehicleSwapRequest

VehicleSwap
Requires Authentication
The following routes are available for this service:
PUT/v1/VehicleSwapUpdates vehicle swap, order and back order recordsThis endpoint validates a swap vehicle and then calls an endpoint in the Agency API to update vehicle swap, order and back order and sends a message to OneAgent with the updated order vehicle and offers
UpdateVehicleSwapRequest Parameters:
NameParameterData TypeRequiredDescription
VehicleSwapGuidbodyGuidNo
OrderGuidbodyGuidNo
BackOrderGuidbodyGuid?No
GssnIdbodystringYes
AgentbodystringYes
ExistingVinbodystringYes
SwapVinbodystringYes
PersonalisedItemOfferIdsbodyint[]No
UpdateVehicleSwapResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorsformList<VehicleError>No
VehicleError Parameters:
NameParameterData TypeRequiredDescription
FieldformstringYes
MessageformstringYes

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.

PUT /v1/VehicleSwap HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	VehicleSwapGuid: 00000000000000000000000000000000,
	OrderGuid: 00000000000000000000000000000000,
	BackOrderGuid: 00000000000000000000000000000000,
	GssnId: String,
	Agent: String,
	ExistingVin: String,
	SwapVin: String,
	PersonalisedItemOfferIds: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Errors: 
	[
		{
			Field: String,
			Message: String
		}
	]
}