| 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 |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| VehicleSwapGuid | body | Guid | No | |
| OrderGuid | body | Guid | No | |
| BackOrderGuid | body | Guid? | No | |
| GssnId | body | string | Yes | |
| Agent | body | string | Yes | |
| ExistingVin | body | string | Yes | |
| SwapVin | body | string | Yes | |
| PersonalisedItemOfferIds | body | int[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Errors | form | List<VehicleError> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Field | form | string | Yes | |
| Message | form | string | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length
{"Errors":[{"Field":"String","Message":"String"}]}