Skip to content

Get fields

GET /product/fields

Get a list of all fields available within the scope of your API key.
The value from fieldKey is typically the value provided in other endpoints.

This endpoint does not return available meta data field.
The use of meta data is customer specific, and will be tailored on an as-needed basis.

alias will be provided if the field has a defined alias, this may be used in place of the fieldKey where applicable.
options will only be returned for type options

No request body required
{
    "message": [
        ...
        {
            "fieldKey": string,
            "label": string,
            "type": string,

            // These keys depend on above conditions
            "options": array,
            "alias": string
        },
        ...
    ],
    "status": enum
}
<?php
    $ch = curl_init();

    curl_setopt_array($ch, [
        CURLOPT_URL => 'https://YOUR-ENVIRONMENT.fleet.autoproff.com/api/product/create',
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_FOLLOWLOCATION => true,
        CURLOPT_CUSTOMREQUEST => 'GET',
        CURLOPT_HTTPHEADER => [
            'X-Api-Key: YOUR-API-KEY'
        ],
    ]);

    $response = curl_exec($ch);

    curl_close($ch);

Current available field types are:

Type Format
text Single line text
textarea Multi-line text
options Any value provided from options
date YYYY-DD-MM or YYYY-DD-MM HH:MM:SS
boolean true, false or NULL
number 1000.00