Skip to main content

This end-point saves items, for a dealer, which are required at the time of appointment checkin. Eg- A dealer could ask customer to submit items like insurance and credit card prior to checkin.​

Item could be any document which is required for the customer to sign and send back to the dealer, it could be a video or images of vehicle which dealer requires before checkin or could be anything(like VIN) which dealer wants the customer to scan.
ApiScope: manage.dealer.supported.item.write
API Scope Level: DealerScope

Path Parameters
    ServiceSubscriberDealer string required
Request Body required
    dealerSupportedItem object
    id int64
    uuid string
    type string
    name string
    action string
    description string
    dealerUuid string
    required boolean
    approvalNeeded boolean
    maintainHistory boolean
    vaultSupportedDataUuid string
    isValid boolean
    dealerAssociatesWithApprovalAuthority object[]
  • Array [
    • userUuid string
    departmentUuid string
    dealerSupportedItemUuid string
    isValid boolean
  • ]
    • dealerSupportedItemMetaData object
    dealerSupportedItemUuid string
    fileText string
    fileUrl string
    isBackPageSupported boolean
    invalidateAllDealerAssociatesWithApprovalAuthority boolean
Responses

OK

Schema
    errors object[]
  • Array [
    • errorCode int32
    errorTitle string
    errorMessage string
  • ]
    • warnings object[]
  • Array [
    • warningCode int32
    warningTitle string
    warningMessage string
  • ]
    • apiRequestId string
    dealerSupportedItemUuid string
PUT /v2/dealer/:ServiceSubscriberDealer/supportedItem

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL
/manage
Username
Password
ServiceSubscriberDealer — path required
Body required
{

  "dealerSupportedItem": {

    "id": 0,

    "uuid": "string",

    "type": "string",

    "name": "string",

    "action": "string",

    "description": "string",

    "dealerUuid": "string",

    "required": true,

    "approvalNeeded": true,

    "maintainHistory": true,

    "vaultSupportedDataUuid": "string",

    "isValid": true,

    "dealerAssociatesWithApprovalAuthority": [

      {

        "userUuid": "string",

        "departmentUuid": "string",

        "dealerSupportedItemUuid": "string",

        "isValid": true

      }

    ],

    "dealerSupportedItemMetaData": {

      "dealerSupportedItemUuid": "string",

      "fileText": "string",

      "fileUrl": "string"

    },

    "isBackPageSupported": true

  },

  "invalidateAllDealerAssociatesWithApprovalAuthority": true

}
Accept
curl / cURL
curl -L -X PUT '/manage/v2/dealer/:ServiceSubscriberDealer/supportedItem' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerSupportedItem": {
    "id": 0,
    "uuid": "string",
    "type": "string",
    "name": "string",
    "action": "string",
    "description": "string",
    "dealerUuid": "string",
    "required": true,
    "approvalNeeded": true,
    "maintainHistory": true,
    "vaultSupportedDataUuid": "string",
    "isValid": true,
    "dealerAssociatesWithApprovalAuthority": [
      {
        "userUuid": "string",
        "departmentUuid": "string",
        "dealerSupportedItemUuid": "string",
        "isValid": true
      }
    ],
    "dealerSupportedItemMetaData": {
      "dealerSupportedItemUuid": "string",
      "fileText": "string",
      "fileUrl": "string"
    },
    "isBackPageSupported": true
  },
  "invalidateAllDealerAssociatesWithApprovalAuthority": true
}'