| PUT | /v1/VehicleSwap | Updates vehicle swap, order and back order records | This 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 |
|---|
"use strict";
export class VehicleError {
/** @param {{Field?:string,Message?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Field;
/** @type {string} */
Message;
}
export class UpdateVehicleSwapResponse {
/** @param {{Errors?:VehicleError[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?VehicleError[]} */
Errors;
}
export class UpdateVehicleSwapRequest {
/** @param {{VehicleSwapGuid?:string,OrderGuid?:string,BackOrderGuid?:string,GssnId?:string,Agent?:string,ExistingVin?:string,SwapVin?:string,PersonalisedItemOfferIds?:number[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
VehicleSwapGuid;
/** @type {string} */
OrderGuid;
/** @type {?string} */
BackOrderGuid;
/** @type {string} */
GssnId;
/** @type {string} */
Agent;
/** @type {string} */
ExistingVin;
/** @type {string} */
SwapVin;
/** @type {?number[]} */
PersonalisedItemOfferIds;
}
JavaScript UpdateVehicleSwapRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}