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

{
  "message": "No query results for model [App\\Models\\Shop] 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
curl -X POST "https://api.sellauth.com/v1/shops/{shopId}/custom-fields" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "uizvphenhfbidi",
    "placeholder": "ommuprzcrjlrcdb",
    "hint": "isdhtloan",
    "type": "textarea",
    "options": "nxgtoahsmbhxgcm",
    "default": "uhobixs",
    "regex": "dpxxmcuww",
    "is_required": false
  }'

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
customFieldIdRequiredstring
curl -X DELETE "https://api.sellauth.com/v1/shops/{shopId}/custom-fields/sit" \
  -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
customFieldIdRequiredstring
curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/custom-fields/sit" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "r",
    "placeholder": "eimerubobychflh",
    "hint": "txqmonyrybbw",
    "type": "select",
    "options": "kdqxfkfhjasorgwhu",
    "default": "syywfommb",
    "regex": "ndfmeopahrddbegszx",
    "is_required": false
  }'