SellAuth

Custom Fields

Get Custom Fields

Retrieves the custom fields.

GET
/v1/shops/{shopId}/custom-fields

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Path Parameters

shopIdRequiredinteger

The shop ID.

curl -X GET "https://api.sellauth.com/v1/shops/{shopId}/custom-fields" \
  -H "Authorization: Bearer <token>"

{
  "current_page": 1,
  "data": [
    {
      "id": 21,
      "shop_id": 38,
      "name": "Your Name",
      "placeholder": null,
      "hint": null,
      "type": "text",
      "options": null,
      "default": null,
      "regex": null,
      "is_required": true,
      "created_at": "2026-01-25T17:02:06.000000Z",
      "updated_at": "2026-01-25T17:02:06.000000Z"
    }
  ],
  "first_page_url": "https://api.sellauth.com/v1/shops/38/custom-fields?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://api.sellauth.com/v1/shops/38/custom-fields?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "active": false
    },
    {
      "url": "https://api.sellauth.com/v1/shops/38/custom-fields?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "https://api.sellauth.com/v1/shops/38/custom-fields",
  "per_page": 10,
  "prev_page_url": null,
  "to": 1,
  "total": 1
}

Create Custom Field

Creates a new custom field.

POST
/v1/shops/{shopId}/custom-fields

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonRequired
nameRequiredstring

Must not be greater than 255 characters.

placeholderstring

Must not be greater than 255 characters.

hintstring

Must not be greater than 255 characters.

typeRequiredstring
Value in: "text" | "textarea" | "checkbox" | "select"
optionsstring

Must not be greater than 255 characters.

defaultstring

Must not be greater than 255 characters.

regexstring

Must not be greater than 255 characters.

is_requiredboolean

Path Parameters

shopIdRequiredinteger

The shop ID.

curl -X POST "https://api.sellauth.com/v1/shops/{shopId}/custom-fields" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "pasyzwszwtxpeqq",
    "placeholder": "ikymwkiinfowtzm",
    "hint": "ixkolowyuffszfr",
    "type": "textarea",
    "options": "snwwxvxezhebdrx",
    "default": "kpiypmuihrdifek",
    "regex": "zagqzitsslufxbo",
    "is_required": true
  }'

Delete Custom Field

Deletes a custom field.

DELETE
/v1/shops/{shopId}/custom-fields/{customFieldId}

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Path Parameters

shopIdRequiredinteger

The shop ID.

customFieldIdRequiredinteger

The custom field ID.

curl -X DELETE "https://api.sellauth.com/v1/shops/{shopId}/custom-fields/{customFieldId}" \
  -H "Authorization: Bearer <token>"

Update Custom Field

Updates an existing custom field.

PUT
/v1/shops/{shopId}/custom-fields/{customFieldId}

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonRequired
nameRequiredstring

Must not be greater than 255 characters.

placeholderstring

Must not be greater than 255 characters.

hintstring

Must not be greater than 255 characters.

typeRequiredstring
Value in: "text" | "textarea" | "checkbox" | "select"
optionsstring

Must not be greater than 255 characters.

defaultstring

Must not be greater than 255 characters.

regexstring

Must not be greater than 255 characters.

is_requiredboolean

Path Parameters

shopIdRequiredinteger

The shop ID.

customFieldIdRequiredinteger

The custom field ID.

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/custom-fields/{customFieldId}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "pasyzwszwtxpeqq",
    "placeholder": "ikymwkiinfowtzm",
    "hint": "ixkolowyuffszfr",
    "type": "textarea",
    "options": "snwwxvxezhebdrx",
    "default": "kpiypmuihrdifek",
    "regex": "zagqzitsslufxbo",
    "is_required": true
  }'