Dealer Types

Dealers all have a specific type assigned to them. For the majority of dealers will will be motor, but this API will allow you to modify and retrieve types.

The Dealer Type Resource

Properties

Name
id
Required
Type
integer
Description
Unique identifier for the dealer type record. This is not the dealer ID.
Name
dealer_id
Required
Type
integer
Description
The unique ID for the dealer.
Name
type
Required
Type
DealerTypeEnum
Description
Contains the dealer type value as a machine-friendly string.
Name
dates.created_at
Required
Type
datetime
Description
The date the dealer type record was created, represented in YYYY-MM-DD HH:MM:SS format
Name
dates.updated_at
Required
Type
datetime
Description
The date the dealer's type was last updated, represented in YYYY-MM-DD HH:MM:SS format
Name
dates.deleted_at
Required
Type
null | datetime
Description
The date the dealer's type was deleted, represented in YYYY-MM-DD HH:MM:SS format. If the dealer type is not deleted, this will be null

Dealer Type Resource

{
  "id": 1,
  "dealer_id": 12345,
  "type": "motor",
  "dates": {
    "created_at": "2024-01-01 00:00:00",
    "updated_at": "2024-01-02 12:00:00",
    "deleted_at": null,
  }
}

GET/v2/dealers/:dealer_id/type

Retrieve Dealers Type

Will retrieve a specific dealers type

URL Parameters

Name
dealer_id
Required
required
Type
integer
Description
ID of the dealer to retrieve

Error Codes

Status	Description
404	The requested dealer could not be found

Request

GET

/v2/dealers/:dealer_id/type

use Compliance\Sdk\ApexV3\Contracts\ApexV3SdkInterface;
use Compliance\Sdk\Authentication\Types\Machine;

private ApexV3SdkInterface $sdk;

$response = $this->sdk
  ->v2(new Machine())
  ->dealer(1)
  ->type();

Response

{
  "data": {
    "dealer_id": 1,
    "type": "motor",
    "dates": {
      "created_at": "2024-01-01 00:00:00",
      "updated_at": "2024-01-02 00:00:00",
      "deleted_at": null,
    }
  }
}

PUT/v2/dealers/:dealer_id/type

Update Dealer Type

Will attempt to update the the type value of the dealer.

URL Parameters

Name
dealer_id
Required
required
Type
integer
Description
ID of the dealer to update

Payload

Name
type
Required
Type
DealerTypeEnum
Description
The new type value for the dealer

Error Codes

Status	Description
404	The requested dealer could not be found.
422	The data provided in the payload was invalid. See errors for more details.

Request

PUT

/dealers/:dealer_id/type

use Compliance\Sdk\ApexV3\Contracts\ApexV3SdkInterface;
use Compliance\Sdk\Authentication\Types\Machine;

private ApexV3SdkInterface $sdk;

$response = $this->sdk
  ->v2(new Machine())
  ->dealer(1)
  ->update([
    'type' => 'motor',
  ]);

Response

{
  "data": {
    "dealer_id": 1,
    "type": "motor",
    "dates": {
      "created_at": "2024-01-01 00:00:00",
      "updated_at": "2024-01-02 00:00:00",
      "deleted_at": null,
    }
  }
}